Compare commits

..

3 Commits

Author SHA1 Message Date
Andreas Hocevar e065c851de Add dist for backport 2017-12-28 12:31:11 +01:00
Andreas Hocevar ed29dde552 Clone backgroundFill and backgroundStroke 2017-12-27 11:51:34 +01:00
Andreas Hocevar 8a73db9331 Apply fill and stroke only when set 2017-12-27 09:31:41 +01:00
1148 changed files with 194138 additions and 96616 deletions
-1
View File
@@ -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/
+1
View File
@@ -6,3 +6,4 @@ In order to get your proposed changes merged into the master branch, we ask you
- [ ] It contains one or more small, incremental, logically separate commits, with no merge commits. - [ ] It contains one or more small, incremental, logically separate commits, with no merge commits.
- [ ] I have used clear commit messages. - [ ] I have used clear commit messages.
- [ ] Existing tests pass for me locally & I have added or updated tests for new or changed functionality. - [ ] Existing tests pass for me locally & I have added or updated tests for new or changed functionality.
- [ ] The work herein is covered by a valid [Contributor License Agreement (CLA)](https://github.com/openlayers/cla).
-1
View File
@@ -2,4 +2,3 @@
/coverage/ /coverage/
/dist/ /dist/
/node_modules/ /node_modules/
src/index.js
+1
View File
@@ -0,0 +1 @@
/build/
+5
View File
@@ -1,9 +1,14 @@
sudo: false
language: node_js language: node_js
node_js: node_js:
- '8' - '8'
cache: cache:
directories: directories:
- node_modules - node_modules
before_script:
- rm src/ol/renderer/webgl/*shader.js
- rm src/ol/renderer/webgl/*shader/locations.js
script: make ci
after_success: after_success:
- cat coverage/lcov.info | coveralls - cat coverage/lcov.info | coveralls
branches: branches:
+96 -1
View File
@@ -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
@@ -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.
+89 -7
View File
@@ -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:5000/> 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.
+271 -4
View File
@@ -1,13 +1,280 @@
OS := $(shell uname)
BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
SRC_GLSL := $(shell find src -type f -name '*.glsl') SRC_GLSL := $(shell find src -type f -name '*.glsl')
SRC_SHADER_JS := $(patsubst %shader.glsl,%shader.js,$(SRC_GLSL)) SRC_SHADER_JS := $(patsubst %shader.glsl,%shader.js,$(SRC_GLSL))
SRC_SHADERLOCATIONS_JS := $(patsubst %shader.glsl,%shader/Locations.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 .PHONY: shaders
shaders: $(SRC_SHADER_JS) $(SRC_SHADERLOCATIONS_JS) shaders: $(SRC_SHADER_JS $(SRC_SHADERLOCATIONS_JS)
%shader.js: %shader.glsl src/ol/webgl/shader.mustache tasks/glslunit.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 > $@ @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 %shader/locations.js: %shader.glsl src/ol/webgl/shaderlocations.mustache tasks/glslunit.js build/timestamps/node-modules-timestamp
@mkdir -p $(@D) @mkdir -p $(@D)
@node tasks/glslunit.js --input $< | ./node_modules/.bin/mustache - src/ol/webgl/shaderlocations.mustache > $@ @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
+2 -1
View File
@@ -4,7 +4,6 @@
[![Greenkeeper badge](https://badges.greenkeeper.io/openlayers/openlayers.svg)](https://greenkeeper.io/) [![Greenkeeper badge](https://badges.greenkeeper.io/openlayers/openlayers.svg)](https://greenkeeper.io/)
[![Coverage Status](https://coveralls.io/repos/github/openlayers/openlayers/badge.svg?branch=master)](https://coveralls.io/github/openlayers/openlayers?branch=master) [![Coverage Status](https://coveralls.io/repos/github/openlayers/openlayers/badge.svg?branch=master)](https://coveralls.io/github/openlayers/openlayers?branch=master)
[![OSGeo Project](https://img.shields.io/badge/OSGeo-Project-brightgreen.svg)](http://osgeo.org/) [![OSGeo Project](https://img.shields.io/badge/OSGeo-Project-brightgreen.svg)](http://osgeo.org/)
[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/openlayers/badge?style=rounded)](https://www.jsdelivr.com/package/npm/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 2-clause BSD License (also known as the FreeBSD). [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).
@@ -19,6 +18,8 @@ Use one of the following methods to use OpenLayers in your project:
* 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) * 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)
* 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).
## Supported Browsers ## Supported Browsers
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`. 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`.
+33
View 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
View 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
View 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
View 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
View 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:])
-159
View File
@@ -1,164 +1,5 @@
## Upgrade notes ## Upgrade notes
### Next release
#### `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 following methods did get the optional this (i.e. opt_this) arguments removed. 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
* source/TileUTFGrid#forDataAtCoordinateAndResolution
* source/Vector#forEachFeature, #forEachFeatureInExtent, #forEachFeatureIntersectingExtent
### v4.6.0 ### v4.6.0
#### Renamed `exceedLength` option of `ol.style.Text` to `overflow` #### Renamed `exceedLength` option of `ol.style.Text` to `overflow`
-7
View File
@@ -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))
+45
View 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
View 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
}
}
@@ -12,7 +12,7 @@
{{{ 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>
@@ -52,13 +52,14 @@
<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 id="source-controls"> <div id="source-controls">
<a id="copy-button" data-clipboard-target="#example-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> --> <a id="codepen-button"><i class="fa fa-codepen"></i> Edit</a>
</div> </div>
<form method="POST" id="codepen-form" target="_blank" action="https://codepen.io/pen/define/"> <form method="POST" id="codepen-form" target="_blank" action="https://codepen.io/pen/define/">
<textarea class="hidden" name="title">{{ title }}</textarea> <textarea class="hidden" name="title">{{ title }}</textarea>
@@ -66,6 +67,7 @@
<textarea class="hidden" name="js">{{ js.source }}</textarea> <textarea class="hidden" name="js">{{ js.source }}</textarea>
<textarea class="hidden" name="css">{{ css.source }}</textarea> <textarea class="hidden" name="css">{{ css.source }}</textarea>
<textarea class="hidden" name="html">{{ contents }}</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"> <input type="hidden" name="data">
</form> </form>
<pre><code id="example-source" class="language-markup">&lt;!DOCTYPE html&gt; <pre><code id="example-source" class="language-markup">&lt;!DOCTYPE html&gt;
@@ -75,7 +77,7 @@
&lt;link rel="stylesheet" href="https://openlayers.org/en/v{{ olVersion }}/css/ol.css" type="text/css"&gt; &lt;link rel="stylesheet" href="https://openlayers.org/en/v{{ olVersion }}/css/ol.css" type="text/css"&gt;
&lt;!-- The line below is only needed for old environments like Internet Explorer and Android 4.x --&gt; &lt;!-- The line below is only needed for old environments like Internet Explorer and Android 4.x --&gt;
&lt;script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"&gt;&lt;/script&gt; &lt;script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"&gt;&lt;/script&gt;
{{#if extraHead.remote}} &lt;script src="https://openlayers.org/en/v{{ olVersion }}/build/ol.js"&gt;&lt;/script&gt;{{#if extraHead.remote}}
{{ indent extraHead.remote spaces=4 }}{{/if}}{{#if css.source}} {{ indent extraHead.remote spaces=4 }}{{/if}}{{#if css.source}}
&lt;style&gt; &lt;style&gt;
{{ indent css.source spaces=6 }} &lt;/style&gt;{{/if}} {{ indent css.source spaces=6 }} &lt;/style&gt;{{/if}}
@@ -103,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');
+35 -33
View File
@@ -1,36 +1,38 @@
{ {
"opts": { "opts": {
"recurse": true, "recurse": true,
"template": "config/jsdoc/api/template" "template": "config/jsdoc/api/template"
},
"tags": {
"allowUnknownTags": true
},
"source": {
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_",
"include": [
"src/ol"
]
},
"plugins": [
"plugins/markdown",
"config/jsdoc/api/plugins/normalize-exports",
"config/jsdoc/api/plugins/inline-options",
"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" "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
} }
+37 -30
View File
@@ -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 [map](module-ol_Map-Map.html) is made of [layers](module-ol_layer_Base-BaseLayer.html), a [view](module-ol_View-View.html) to visualize them, [interactions](module-ol_interaction_Interaction-Interaction.html) to modify map content and [controls](module-ol_control_Control-Control.html) 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>
[Overview](module-ol_Map-Map.html)<br> [Overview](ol.Map.html)<br>
[Creation](module-ol_Map-Map.html#Map)<br> [Creation](ol.Map.html#Map)<br>
[Events](module-ol_MapBrowserEvent-MapBrowserEvent.html)</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>
[View](module-ol_View-View.html) 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 [sources](module-ol_source_Source-Source.html).</p> <td><p>Layers are lightweight containers that get their data from [sources](ol.source.html).</p>
[layer/Tile](module-ol_layer_Tile-TileLayer.html)<br> [ol.layer.Tile](ol.layer.Tile.html)<br>
[layer/Image](module-ol_layer_Image-ImageLayer.html)<br> [ol.layer.Image](ol.layer.Image.html)<br>
[layer/Vector](module-ol_layer_Vector-VectorLayer.html)<br> [ol.layer.Vector](ol.layer.Vector.html)<br>
[layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html)</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>[Map default controls](module-ol_control_util.html#.defaults)<br> <td>[Map default controls](ol.control.html#.defaults)<br>
[All controls](module-ol_control_Control-Control.html) [All controls](ol.control.html)
</td> </td>
<td> <td>
[Map default interactions](module-ol_interaction.html#~defaults)<br> [Map default interactions](ol.interaction.html#.defaults)<br>
Interactions for [vector features](module-ol_Feature-Feature.html) Interactions for [vector features](ol.Feature.html)
<ul><li>[interaction/Select](module-ol_interaction_Select-Select.html)</li> <ul><li>[ol.interaction.Select](ol.interaction.Select.html)</li>
<li>[interaction/Draw](module-ol_interaction_Draw-Draw.html)</li> <li>[ol.interaction.Draw](ol.interaction.Draw.html)</li>
<li>[interaction/Modify](module-ol_interaction_Modify-Modify.html)</li></ul> <li>[ol.interaction.Modify](ol.interaction.Modify.html)</li></ul>
[All interactions](module-ol_interaction_Interaction-Interaction.html)</td> [All interactions](ol.interaction.html)</td>
<td>[Tile sources](module-ol_source_Tile-TileSource.html) for [layer/Tile](module-ol_layer_Tile-TileLayer.html) <td>[Tile sources](ol.source.Tile.html) for [ol.layer.Tile](ol.layer.Tile.html)
<br>[Image sources](module-ol_source_Image-ImageSource.html) for [layer/Image](module-ol_layer_Image-ImageLayer.html) <br>[Image sources](ol.source.Image.html) for [ol.layer.Image](ol.layer.Image.html)
<br>[Vector sources](module-ol_source_Vector-VectorSource.html) for [layer/Vector](module-ol_layer_Vector-VectorLayer.html) <br>[Vector sources](ol.source.Vector.html) for [ol.layer.Vector](ol.layer.Vector.html)
<br>[Vector tile sources](module-ol_source_VectorTile-VectorTile.html) for [layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html) <br>[Vector tile sources](ol.source.VectorTile.html) for [ol.layer.VectorTile](ol.layer.VectorTile.html)
<br>[Formats](module-ol_format_Feature-FeatureFormat.html) for reading/writing vector data <br>[Formats](ol.format.Feature.html) for reading/writing vector data
<br>[format/WMSCapabilities](module-ol_format_WMSCapabilities-WMSCapabilities.html)</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 [proj.transform()](module-ol_proj.html#.transform) and [proj.transformExtent()](module-ol_proj.html#.transformExtent).</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>
[ol/proj](module-ol_proj.html)</td> [ol.proj](ol.proj.html)</td>
<td><p>Changes to all [ol/Object](module-ol_Object-BaseObject.html)s can be observed by calling the [object.on('propertychange')](module-ol_Object-BaseObject.html#on) method. Listeners receive an [ol/Object~ObjectEvent](module-ol_Object-ObjectEvent.html) 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>
[ol/Geolocation](module-ol_Geolocation.html)<br> [ol.Geolocation](ol.Geolocation.html)<br>
[ol/Overlay](module-ol_Overlay-Overlay.html)<br></td> [ol.Overlay](ol.Overlay.html)<br></td>
</tr></table> </tr></table>
&nbsp; &nbsp;
@@ -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.
+26 -29
View File
@@ -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,9 +94,13 @@ 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);
} }
// Mark explicity defined namespaces - needed in parseComplete to keep // Mark explicity defined namespaces - needed in parseComplete to keep
@@ -104,15 +109,14 @@ exports.handlers = {
doclet.namespace_ = true; doclet.namespace_ = true;
} }
if (doclet.kind == 'class') { if (doclet.kind == 'class') {
modules[doclet.longname.split('~').shift()] = true;
classes[doclet.longname] = doclet; classes[doclet.longname] = doclet;
} }
}, },
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 || doclet.namespace_) { if (doclet.stability || doclet.namespace_) {
if (doclet.kind == 'class') { if (doclet.kind == 'class') {
includeAugments(doclet); includeAugments(doclet);
@@ -130,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
+7 -7
View File
@@ -1,11 +1,11 @@
const events = {}; var events = {};
const classes = {}; var classes = {};
exports.handlers = { exports.handlers = {
newDoclet: function(e) { newDoclet: function(e) {
const doclet = e.doclet; var doclet = e.doclet;
let cls; var cls;
if (doclet.kind == 'event') { if (doclet.kind == 'event') {
cls = doclet.longname.split('#')[0]; cls = doclet.longname.split('#')[0];
if (!(cls in events)) { if (!(cls in events)) {
@@ -18,8 +18,8 @@ exports.handlers = {
}, },
parseComplete: function(e) { parseComplete: function(e) {
const doclets = e.doclets; var doclets = e.doclets;
let doclet, i, ii, j, jj, event, fires; var doclet, i, ii, j, jj, event, fires;
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];
if (doclet.fires) { if (doclet.fires) {
@@ -28,7 +28,7 @@ exports.handlers = {
for (j = 0, jj = doclet.fires.length; j < jj; ++j) { for (j = 0, jj = doclet.fires.length; j < jj; ++j) {
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 { } else {
fires.push(doclet.fires[j]); fires.push(doclet.fires[j]);
} }
+109
View File
@@ -0,0 +1,109 @@
/*
* This is a hack to prevent inheritDoc tags from entirely removing
* 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) {
dictionary.defineTag('inheritDoc', {
mustHaveValue: false,
canHaveType: false,
canHaveName: false,
onTagged: function(doclet, tag) {
doclet.inheritdoc = true;
}
});
};
var lookup = {};
var incompleteByClass = {};
var keepKeys = ['comment', 'meta', 'name', 'memberof', 'longname', 'augment',
'stability'];
exports.handlers = {
newDoclet: function(e) {
var doclet = e.doclet;
var incompletes;
if (!(doclet.longname in lookup)) {
lookup[doclet.longname] = [];
}
lookup[doclet.longname].push(doclet);
if (doclet.inheritdoc) {
if (!(doclet.memberof in incompleteByClass)) {
incompleteByClass[doclet.memberof] = [];
}
incompletes = incompleteByClass[doclet.memberof];
if (incompletes.indexOf(doclet.name) == -1) {
incompletes.push(doclet.name);
}
}
},
parseComplete: function(e) {
var ancestors, candidate, candidates, doclet, i, j, k, l, key;
var incompleteDoclet, stability, incomplete, incompletes;
var doclets = e.doclets;
for (i = doclets.length - 1; i >= 0; --i) {
doclet = doclets[i];
if (doclet.augments) {
ancestors = [].concat(doclet.augments);
}
incompletes = incompleteByClass[doclet.longname];
if (ancestors && incompletes) {
// collect ancestors from the whole hierarchy
for (j = 0; j < ancestors.length; ++j) {
candidates = lookup[ancestors[j]];
if (candidates) {
for (k = candidates.length - 1; k >= 0; --k) {
candidate = candidates[k];
if (candidate.augments) {
ancestors = ancestors.concat(candidate.augments);
}
}
}
}
// walk through all inheritDoc members
for (j = incompletes.length - 1; j >= 0; --j) {
incomplete = incompletes[j];
candidates = lookup[doclet.longname + '#' + incomplete];
if (candidates) {
// get the incomplete doclet that needs to be augmented
for (k = candidates.length - 1; k >= 0; --k) {
incompleteDoclet = candidates[k];
if (incompleteDoclet.inheritdoc) {
break;
}
}
}
// find the documented ancestor
for (k = ancestors.length - 1; k >= 0; --k) {
candidates = lookup[ancestors[k] + '#' + incomplete];
if (candidates) {
for (l = candidates.length - 1; l >= 0; --l) {
candidate = candidates[l];
if (candidate && !candidate.inheritdoc) {
stability = candidate.stability || incompleteDoclet.stability;
if (stability) {
incompleteDoclet.stability = stability;
for (key in candidate) {
if (candidate.hasOwnProperty(key) &&
keepKeys.indexOf(key) == -1) {
incompleteDoclet[key] = candidate[key];
}
}
}
}
}
}
}
}
}
}
}
};
@@ -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,106 +0,0 @@
/**
* @filedesc
* Expands module path type to point to default export when no name is given
*/
const fs = require('fs');
const path = require('path');
let moduleRoot;
function addDefaultExportPath(obj) {
if (!Array.isArray(obj)) {
obj = obj.names;
}
obj.forEach((name, index) => {
const matches = name.match(/module\:([^>|),\.<]|)+/g);
if (matches) {
matches.forEach(module => {
if (!/[~\.]/.test(module)) {
const checkFile = path.resolve(moduleRoot, module.replace(/^module\:/, ''));
const file = fs.readFileSync(require.resolve(checkFile), 'utf-8');
const lines = file.split('\n');
let hasDefaultExport = false;
for (let i = 0, ii = lines.length; i < ii; ++i) {
hasDefaultExport = hasDefaultExport || /^export default [^\{]/.test(lines[i]);
const match = lines[i].match(/^export default ([A-Za-z_$][A-Za-z0-9_$]+);$/);
if (match) {
// Use variable name if default export is assigned to a variable.
obj[index] = name = name.replace(module, `${module}~${match[1]}`);
return;
}
}
if (hasDefaultExport) {
// Duplicate last part if default export is not assigned to a variable.
obj[index] = name = name.replace(module, `${module}~${module.split('/').pop()}`);
}
}
});
}
});
}
function replaceLinks(comment) {
const matches = comment.match(/\{@link [^\} #]+}/g);
if (matches) {
const modules = matches.map(m => {
const mm = m.match(/(module:[^\}]+)}$/);
if (mm) {
return mm[1];
}
}).filter(m => !!m);
const newModules = modules.concat();
addDefaultExportPath(newModules);
modules.forEach((module, i) => {
comment = comment.replace(module, newModules[i]);
});
}
return comment;
}
exports.handlers = {
/**
* Adds default export to module path types without name
* @param {Object} e Event object.
*/
newDoclet: function(e) {
const doclet = e.doclet;
if (doclet.kind == 'module') {
const levelsUp = doclet.longname.replace(/^module\:/, '').split('/');
if (doclet.meta.filename != 'index.js') {
levelsUp.pop();
}
const pathArgs = [doclet.meta.path].concat(levelsUp.map(() => '../'));
moduleRoot = path.resolve.apply(null, pathArgs);
} else {
if (doclet.description) {
doclet.description = replaceLinks(doclet.description);
}
if (doclet.classdesc) {
doclet.classdesc = replaceLinks(doclet.classdesc);
}
const module = doclet.longname.split('#').shift();
if (module.indexOf('module:') == 0 && module.indexOf('.') !== -1) {
doclet.longname = doclet.longname.replace(module, module.replace('.', '~'));
}
if (doclet.augments) {
addDefaultExportPath(doclet.augments);
}
if (doclet.params) {
doclet.params.forEach(p => addDefaultExportPath(p.type));
}
if (doclet.returns) {
doclet.returns.forEach(r => addDefaultExportPath(r.type));
}
if (doclet.properties) {
doclet.properties.forEach(p => addDefaultExportPath(p.type));
}
if (doclet.type) {
addDefaultExportPath(doclet.type);
}
}
}
};
+9 -9
View File
@@ -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') { 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);
} }
+62 -24
View File
@@ -1,27 +1,49 @@
/* /*
* Converts olx.js @type annotations into properties of the previous @typedef.
* Changes @enum annotations into @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 // types that are undefined or typedefs containing undefined
let undefinedLikes = null; 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 required. * Changes the description of the param, if it is found to be a required
* @param {Object} doclet The doclet. * option of an olxTypeName.
* @returns {Object} The modified doclet.
*/ */
function markRequiredIfNeeded(doclet) { function markRequiredIfNeeded(doclet){
const memberof = doclet.memberof; var memberof = doclet.memberof;
if (!memberof) { // only check doclets that belong to an olxTypeName
if (!memberof || olxTypeNames.indexOf(memberof) == -1) {
return doclet; return doclet;
} }
const types = doclet.type.names; var types = doclet.type.names;
let isRequiredParam = true; var isRequiredParam = true;
// iterate over all types that are like-undefined (see above for explanation) // iterate over all types that are like-undefined (see above for explanation)
for (let idx = undefinedLikes.length - 1; idx >= 0; idx--) { for (var idx = undefinedLikes.length - 1; idx >= 0; idx--) {
const undefinedLike = undefinedLikes[idx]; var undefinedLike = undefinedLikes[idx];
// … if the current types contains a type that is undefined-like, // … if the current types contains a type that is undefined-like,
// it is not required. // it is not required.
if (types.indexOf(undefinedLike) != -1) { if (types.indexOf(undefinedLike) != -1) {
@@ -30,9 +52,9 @@ function markRequiredIfNeeded(doclet) {
} }
if (isRequiredParam) { if (isRequiredParam) {
const reqSnippet = '<span class="required-option">Required.</span></p>'; var reqSnippet = '<span class="required-option">Required.</span></p>';
const endsWithP = /<\/p>$/i; var endsWithP = /<\/p>$/i;
let description = doclet.description; var description = doclet.description;
if (description && endsWithP.test(description)) { if (description && endsWithP.test(description)) {
description = description.replace(endsWithP, ' ' + reqSnippet); description = description.replace(endsWithP, ' ' + reqSnippet);
} else if (doclet.description === undefined) { } else if (doclet.description === undefined) {
@@ -47,14 +69,13 @@ function markRequiredIfNeeded(doclet) {
* Iterates over all doclets and finds the names of types that contain * Iterates over all doclets and finds the names of types that contain
* undefined. Stores the names in the global variable undefinedLikes, so * undefined. Stores the names in the global variable undefinedLikes, so
* that e.g. markRequiredIfNeeded can use these. * that e.g. markRequiredIfNeeded can use these.
* @param {Array} doclets The doclets.
*/ */
function findTypesLikeUndefined(doclets) { function findTypesLikeUndefined(doclets) {
undefinedLikes = ['undefined']; // include type 'undefined' explicitly undefinedLikes = ['undefined']; // include type 'undefined' explicitly
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.kind === 'typedef') { if(doclet.kind === 'typedef') {
const types = doclet.type.names; var types = doclet.type.names;
if (types.indexOf('undefined') !== -1) { if (types.indexOf('undefined') !== -1) {
// the typedef contains 'undefined', so it self is undefinedLike. // the typedef contains 'undefined', so it self is undefinedLike.
undefinedLikes.push(doclet.longname); undefinedLikes.push(doclet.longname);
@@ -66,8 +87,20 @@ function findTypesLikeUndefined(doclets) {
exports.handlers = { exports.handlers = {
newDoclet: function(e) { newDoclet: function(e) {
const doclet = e.doclet; var doclet = e.doclet;
if (doclet.isEnum) { 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 // We never export enums, so we document them like typedefs
doclet.kind = 'typedef'; doclet.kind = 'typedef';
delete doclet.isEnum; delete doclet.isEnum;
@@ -75,10 +108,15 @@ exports.handlers = {
}, },
parseComplete: function(e) { parseComplete: function(e) {
const doclets = e.doclets; var doclets = e.doclets;
findTypesLikeUndefined(doclets); findTypesLikeUndefined(doclets);
for (let i = doclets.length - 1; i >= 0; --i) { for (var i = doclets.length - 1; i >= 0; --i) {
markRequiredIfNeeded(doclets[i]); var doclet = doclets[i];
var params = doclet.params;
if (params) {
addSubparams(params);
}
markRequiredIfNeeded(doclet);
} }
} }
+15
View File
@@ -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
/** /**
+373 -387
View File
@@ -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);
}); });
} }
/** /**
@@ -173,348 +161,346 @@ function generateSourceFiles(sourceFiles) {
* @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);
}; };
@@ -85,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') + '">' +
@@ -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>
@@ -11,7 +11,7 @@ var self = this;
?> ?>
<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)) { ?>
@@ -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>
+1 -1
View File
@@ -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';
} }
}); });
+2 -1
View File
@@ -11,6 +11,7 @@
}, },
"plugins": [ "plugins": [
"config/jsdoc/info/api-plugin", "config/jsdoc/info/api-plugin",
"config/jsdoc/info/module-plugin" "config/jsdoc/info/define-plugin",
"config/jsdoc/info/virtual-plugin"
] ]
} }
+35
View File
@@ -0,0 +1,35 @@
/**
* @fileoverview This plugin extracts info from boolean defines. This only
* handles boolean defines with the default value in the description. Default
* is assumed to be provided with something like "default is `true`" (case
* insensitive, with or without ticks).
*/
var DEFAULT_VALUE = /default\s+is\s+`?(true|false)`?/i;
/**
* Hook to define new tags.
* @param {Object} dictionary The tag dictionary.
*/
exports.defineTags = function(dictionary) {
dictionary.defineTag('define', {
canHaveType: true,
mustHaveValue: true,
onTagged: function(doclet, tag) {
var types = tag.value.type.names;
if (types.length === 1 && types[0] === 'boolean') {
var match = tag.value.description.match(DEFAULT_VALUE);
if (match) {
doclet.define = {
default: match[1] === 'true'
};
doclet.description = tag.value.description;
}
}
}
});
};
-135
View File
@@ -1,135 +0,0 @@
const path = require('path');
const exportLookup = {};
const moduleLookup = {};
const MODULE_PATH = /^module:(.*)~(\w+)$/;
/**
* Add exports to modules.
*/
exports.handlers = {
symbolFound(event) {
const filename = event.filename;
const node = event.astnode;
let local, exported;
switch (node.type) {
case 'ExportDefaultDeclaration': {
exported = 'default';
switch (node.declaration.type) {
case 'Identifier': {
// export default foo;
local = node.declaration.name;
break;
}
case 'FunctionDeclaration': {
if (!node.declaration.id) {
// export default function() {}
local = '';
} else {
// export default function foo() {}
local = node.declaration.id.name;
}
break;
}
default: {
local = '';
}
}
break;
}
case 'ExportNamedDeclaration': {
if (!node.declaration) {
// export {foo}
// export {foo as bar}
// handled below in ExportSpecifier
return;
}
switch (node.declaration.type) {
case 'FunctionDeclaration': {
if (!node.declaration.id) {
throw new Error(`Expected function declaration to have an id in ${filename}`);
}
const name = node.declaration.id.name;
local = name;
exported = name;
break;
}
default: {
return;
}
}
break;
}
case 'ExportSpecifier': {
if (node.exported.type === 'Identifier') {
exported = node.exported.name;
if (node.local.type === 'Identifier') {
local = node.local.name;
if (node.parent.source) {
const resolved = path.resolve(path.dirname(filename), node.parent.source.value);
local = `module:${resolved}~${local}`;
}
} else {
local = '';
}
} else {
return;
}
break;
}
default: {
return;
}
}
if (!(filename in exportLookup)) {
exportLookup[filename] = {};
}
const exports = exportLookup[filename];
if (exports.hasOwnProperty(exported)) {
throw new Error(`Duplicate export {${local} as ${exported}} in ${filename}`);
}
exports[exported] = local;
},
newDoclet(event) {
const doclet = event.doclet;
if (doclet.kind === 'module') {
const filepath = path.join(doclet.meta.path, doclet.meta.filename);
if (filepath in moduleLookup) {
throw new Error(`Duplicate @module annotation in ${filepath}`);
}
moduleLookup[filepath] = doclet;
}
},
parseComplete(event) {
for (const filepath in moduleLookup) {
const doclet = moduleLookup[filepath];
const exports = exportLookup[filepath];
for (const exported in exports) {
const local = exports[exported];
const match = local.match(MODULE_PATH);
if (match) {
const filepath = match[1];
const mod = moduleLookup[filepath];
if (mod) {
exports[exported] = `module:${mod.name}~${match[2]}`;
}
}
}
doclet.exports = exports; // undefined if no exports
}
}
};
+68 -53
View File
@@ -1,8 +1,9 @@
/** /**
* @fileoverview Generates JSON output based on exportable symbols. * @fileoverview Generates JSON output based on exportable symbols (those with
* 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');
/** /**
@@ -14,55 +15,72 @@ 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 // 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 (this.kind === 'module' || 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 typedefs = []; var defines = [];
const externs = []; var typedefs = [];
const modules = []; 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) {
if (doc.kind == 'module') { var isExterns = (/[\\\/]externs$/).test(doc.meta.path);
modules.push({ 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({
name: doc.longname, name: doc.longname,
exports: doc.exports || null, description: doc.description,
path: path.join(doc.meta.path, doc.meta.filename) path: path.join(doc.meta.path, doc.meta.filename),
default: doc.define.default
}); });
} else if (doc.kind == 'typedef' || doc.isEnum === true) { } else if (doc.kind == 'typedef' || doc.isEnum === true) {
typedefs.push({ typedefs.push({
@@ -70,18 +88,16 @@ 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) {
symbol.extends = doc.augments[0]; symbol.extends = doc.augments[0];
} }
if (doc.memberof) {
symbol.memberof = doc.memberof;
}
if (doc.virtual) { if (doc.virtual) {
symbol.virtual = true; symbol.virtual = true;
} }
@@ -89,11 +105,10 @@ 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
description: param.description
}; };
params.push(paramInfo); params.push(paramInfo);
paramInfo.types = getTypes(param.type.names); paramInfo.types = getTypes(param.type.names);
@@ -127,10 +142,10 @@ exports.publish = function(data, opts) {
}); });
} }
const target = 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);
@@ -154,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,
typedefs: typedefs, defines: defines,
externs: externs, typedefs: typedefs,
base: base, externs: externs,
modules: modules base: base
}, null, 2)); }, null, 2));
}); });
}; };
+16
View File
@@ -0,0 +1,16 @@
/**
* Handle the interface and abstract annotations.
* @param {Object} dictionary The tag dictionary.
*/
exports.defineTags = function(dictionary) {
var classTag = dictionary.lookUp('class');
dictionary.defineTag('interface', {
mustHaveValue: false,
onTagged: function(doclet, tag) {
classTag.onTagged.apply(this, arguments);
doclet.virtual = true;
}
});
};
+4
View File
@@ -0,0 +1,4 @@
{
"exports": ["*"],
"umd": true
}
+38
View 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
View File
@@ -0,0 +1,3 @@
# Configuration Files
This directory includes configuration files for the build scripts in and documentation templates.
-21
View File
@@ -1,21 +0,0 @@
// Rollup configuration for the full build
import noderesolve from 'rollup-plugin-node-resolve';
import commonjs from 'rollup-plugin-commonjs';
import {uglify} from 'rollup-plugin-uglify';
import buble from 'rollup-plugin-buble';
import sourcemaps from 'rollup-plugin-sourcemaps';
export default {
input: 'src/index.js',
output: [
{file: 'build/ol.js', format: 'iife', sourcemap: true}
],
plugins: [
noderesolve(),
commonjs(),
buble(),
uglify(),
sourcemaps()
]
};
+14 -4
View File
@@ -44,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;
@@ -179,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);
} }
@@ -189,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;
} }
+261
View File
@@ -0,0 +1,261 @@
.ol-box {
box-sizing: border-box;
border-radius: 2px;
border: 2px solid blue;
}
.ol-mouse-position {
top: 8px;
right: 8px;
position: absolute;
}
.ol-scale-line {
background: rgba(0,60,136,0.3);
border-radius: 4px;
bottom: 8px;
left: 8px;
padding: 2px;
position: absolute;
}
.ol-scale-line-inner {
border: 1px solid #eee;
border-top: none;
color: #eee;
font-size: 10px;
text-align: center;
margin: 1px;
will-change: contents, width;
}
.ol-overlay-container {
will-change: left,right,top,bottom;
}
.ol-unsupported {
display: none;
}
.ol-viewport, .ol-unselectable {
-webkit-touch-callout: none;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
-webkit-tap-highlight-color: rgba(0,0,0,0);
}
.ol-selectable {
-webkit-touch-callout: default;
-webkit-user-select: auto;
-moz-user-select: auto;
-ms-user-select: auto;
user-select: auto;
}
.ol-grabbing {
cursor: -webkit-grabbing;
cursor: -moz-grabbing;
cursor: grabbing;
}
.ol-grab {
cursor: move;
cursor: -webkit-grab;
cursor: -moz-grab;
cursor: grab;
}
.ol-control {
position: absolute;
background-color: rgba(255,255,255,0.4);
border-radius: 4px;
padding: 2px;
}
.ol-control:hover {
background-color: rgba(255,255,255,0.6);
}
.ol-zoom {
top: .5em;
left: .5em;
}
.ol-rotate {
top: .5em;
right: .5em;
transition: opacity .25s linear, visibility 0s linear;
}
.ol-rotate.ol-hidden {
opacity: 0;
visibility: hidden;
transition: opacity .25s linear, visibility 0s linear .25s;
}
.ol-zoom-extent {
top: 4.643em;
left: .5em;
}
.ol-full-screen {
right: .5em;
top: .5em;
}
@media print {
.ol-control {
display: none;
}
}
.ol-control button {
display: block;
margin: 1px;
padding: 0;
color: white;
font-size: 1.14em;
font-weight: bold;
text-decoration: none;
text-align: center;
height: 1.375em;
width: 1.375em;
line-height: .4em;
background-color: rgba(0,60,136,0.5);
border: none;
border-radius: 2px;
}
.ol-control button::-moz-focus-inner {
border: none;
padding: 0;
}
.ol-zoom-extent button {
line-height: 1.4em;
}
.ol-compass {
display: block;
font-weight: normal;
font-size: 1.2em;
will-change: transform;
}
.ol-touch .ol-control button {
font-size: 1.5em;
}
.ol-touch .ol-zoom-extent {
top: 5.5em;
}
.ol-control button:hover,
.ol-control button:focus {
text-decoration: none;
background-color: rgba(0,60,136,0.7);
}
.ol-zoom .ol-zoom-in {
border-radius: 2px 2px 0 0;
}
.ol-zoom .ol-zoom-out {
border-radius: 0 0 2px 2px;
}
.ol-attribution {
text-align: right;
bottom: .5em;
right: .5em;
max-width: calc(100% - 1.3em);
}
.ol-attribution ul {
margin: 0;
padding: 0 .5em;
font-size: .7rem;
line-height: 1.375em;
color: #000;
text-shadow: 0 0 2px #fff;
}
.ol-attribution li {
display: inline;
list-style: none;
line-height: inherit;
}
.ol-attribution li:not(:last-child):after {
content: " ";
}
.ol-attribution img {
max-height: 2em;
max-width: inherit;
vertical-align: middle;
}
.ol-attribution ul, .ol-attribution button {
display: inline-block;
}
.ol-attribution.ol-collapsed ul {
display: none;
}
.ol-attribution.ol-logo-only ul {
display: block;
}
.ol-attribution:not(.ol-collapsed) {
background: rgba(255,255,255,0.8);
}
.ol-attribution.ol-uncollapsible {
bottom: 0;
right: 0;
border-radius: 4px 0 0;
height: 1.1em;
line-height: 1em;
}
.ol-attribution.ol-logo-only {
background: transparent;
bottom: .4em;
height: 1.1em;
line-height: 1em;
}
.ol-attribution.ol-uncollapsible img {
margin-top: -.2em;
max-height: 1.6em;
}
.ol-attribution.ol-logo-only button,
.ol-attribution.ol-uncollapsible button {
display: none;
}
.ol-zoomslider {
top: 4.5em;
left: .5em;
height: 200px;
}
.ol-zoomslider button {
position: relative;
height: 10px;
}
.ol-touch .ol-zoomslider {
top: 5.5em;
}
.ol-overviewmap {
left: 0.5em;
bottom: 0.5em;
}
.ol-overviewmap.ol-uncollapsible {
bottom: 0;
left: 0;
border-radius: 0 4px 0 0;
}
.ol-overviewmap .ol-overviewmap-map,
.ol-overviewmap button {
display: inline-block;
}
.ol-overviewmap .ol-overviewmap-map {
border: 1px solid #7b98bc;
height: 150px;
margin: 2px;
width: 150px;
}
.ol-overviewmap:not(.ol-collapsed) button{
bottom: 1px;
left: 2px;
position: absolute;
}
.ol-overviewmap.ol-collapsed .ol-overviewmap-map,
.ol-overviewmap.ol-uncollapsible button {
display: none;
}
.ol-overviewmap:not(.ol-collapsed) {
background: rgba(255,255,255,0.8);
}
.ol-overviewmap-box {
border: 2px dotted rgba(0,60,136,0.7);
}
.ol-overviewmap .ol-overviewmap-box:hover {
cursor: move;
}
+96462
View File
File diff suppressed because one or more lines are too long
Vendored
+1
View File
@@ -0,0 +1 @@
.ol-box{box-sizing:border-box;border-radius:2px;border:2px solid #00f}.ol-mouse-position{top:8px;right:8px;position:absolute}.ol-scale-line{background:rgba(0,60,136,.3);border-radius:4px;bottom:8px;left:8px;padding:2px;position:absolute}.ol-scale-line-inner{border:1px solid #eee;border-top:none;color:#eee;font-size:10px;text-align:center;margin:1px;will-change:contents,width}.ol-overlay-container{will-change:left,right,top,bottom}.ol-unsupported{display:none}.ol-unselectable,.ol-viewport{-webkit-touch-callout:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-tap-highlight-color:transparent}.ol-selectable{-webkit-touch-callout:default;-webkit-user-select:auto;-moz-user-select:auto;-ms-user-select:auto;user-select:auto}.ol-grabbing{cursor:-webkit-grabbing;cursor:-moz-grabbing;cursor:grabbing}.ol-grab{cursor:move;cursor:-webkit-grab;cursor:-moz-grab;cursor:grab}.ol-control{position:absolute;background-color:rgba(255,255,255,.4);border-radius:4px;padding:2px}.ol-control:hover{background-color:rgba(255,255,255,.6)}.ol-zoom{top:.5em;left:.5em}.ol-rotate{top:.5em;right:.5em;transition:opacity .25s linear,visibility 0s linear}.ol-rotate.ol-hidden{opacity:0;visibility:hidden;transition:opacity .25s linear,visibility 0s linear .25s}.ol-zoom-extent{top:4.643em;left:.5em}.ol-full-screen{right:.5em;top:.5em}@media print{.ol-control{display:none}}.ol-control button{display:block;margin:1px;padding:0;color:#fff;font-size:1.14em;font-weight:700;text-decoration:none;text-align:center;height:1.375em;width:1.375em;line-height:.4em;background-color:rgba(0,60,136,.5);border:none;border-radius:2px}.ol-control button::-moz-focus-inner{border:none;padding:0}.ol-zoom-extent button{line-height:1.4em}.ol-compass{display:block;font-weight:400;font-size:1.2em;will-change:transform}.ol-touch .ol-control button{font-size:1.5em}.ol-touch .ol-zoom-extent{top:5.5em}.ol-control button:focus,.ol-control button:hover{text-decoration:none;background-color:rgba(0,60,136,.7)}.ol-zoom .ol-zoom-in{border-radius:2px 2px 0 0}.ol-zoom .ol-zoom-out{border-radius:0 0 2px 2px}.ol-attribution{text-align:right;bottom:.5em;right:.5em;max-width:calc(100% - 1.3em)}.ol-attribution ul{margin:0;padding:0 .5em;font-size:.7rem;line-height:1.375em;color:#000;text-shadow:0 0 2px #fff}.ol-attribution li{display:inline;list-style:none;line-height:inherit}.ol-attribution li:not(:last-child):after{content:" "}.ol-attribution img{max-height:2em;max-width:inherit;vertical-align:middle}.ol-attribution button,.ol-attribution ul{display:inline-block}.ol-attribution.ol-collapsed ul{display:none}.ol-attribution.ol-logo-only ul{display:block}.ol-attribution:not(.ol-collapsed){background:rgba(255,255,255,.8)}.ol-attribution.ol-uncollapsible{bottom:0;right:0;border-radius:4px 0 0;height:1.1em;line-height:1em}.ol-attribution.ol-logo-only{background:0 0;bottom:.4em;height:1.1em;line-height:1em}.ol-attribution.ol-uncollapsible img{margin-top:-.2em;max-height:1.6em}.ol-attribution.ol-logo-only button,.ol-attribution.ol-uncollapsible button{display:none}.ol-zoomslider{top:4.5em;left:.5em;height:200px}.ol-zoomslider button{position:relative;height:10px}.ol-touch .ol-zoomslider{top:5.5em}.ol-overviewmap{left:.5em;bottom:.5em}.ol-overviewmap.ol-uncollapsible{bottom:0;left:0;border-radius:0 4px 0 0}.ol-overviewmap .ol-overviewmap-map,.ol-overviewmap button{display:inline-block}.ol-overviewmap .ol-overviewmap-map{border:1px solid #7b98bc;height:150px;margin:2px;width:150px}.ol-overviewmap:not(.ol-collapsed) button{bottom:1px;left:2px;position:absolute}.ol-overviewmap.ol-collapsed .ol-overviewmap-map,.ol-overviewmap.ol-uncollapsible button{display:none}.ol-overviewmap:not(.ol-collapsed){background:rgba(255,255,255,.8)}.ol-overviewmap-box{border:2px dotted rgba(0,60,136,.7)}.ol-overviewmap .ol-overviewmap-box:hover{cursor:move}
Vendored
+1073
View File
File diff suppressed because one or more lines are too long
+10 -2
View File
@@ -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
@@ -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.
+37
View File
@@ -21,6 +21,9 @@ 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-)
* [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?
@@ -332,3 +335,37 @@ var vectorLayer = new ol.layer.Vector({
``` ```
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.
## How do I create a custom build of OpenLayers?
Please refer to the [official create custom builds tutorial](tutorials/custom-builds.html)
which explains how to create a custom build of OpenLayers with just those parts
included that you want.
## Do I need to write my own code using Closure library?
OpenLayers is built on top of the [Google Closure JavaScript
library](https://developers.google.com/closure/library/), but this
does not mean that you must use that library in your application code.
OpenLayers should play well with all sorts of JavaScript libraries out there,
and you are in no way forced to use a specific one. Choose one that looks
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.
+305
View 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.
+237
View 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.
+1
View File
@@ -9,4 +9,5 @@ layout: doc.hbs
* [Basic Concepts](concepts.html) * [Basic Concepts](concepts.html)
* [Create Custom Builds](custom-builds.html) * [Create Custom Builds](custom-builds.html)
* [Bundle Application and OpenLayers using Browserify](browserify.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)
+3
View File
@@ -12,6 +12,9 @@ The initial release aims to support much of the functionality provided by versio
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. 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 ## Public API
Using the advanced optimizations of the Closure Compiler means that properties and methods are renamed &ndash; `longMeaningfulName` might become `xB` &ndash; 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. Using the advanced optimizations of the Closure Compiler means that properties and methods are renamed &ndash; `longMeaningfulName` might become `xB` &ndash; 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.
+1 -1
View File
@@ -107,7 +107,7 @@ In case you are creating a custom build of OpenLayers and do not need the reproj
See [Custom builds](custom-builds.html#defines) tutorial on how to do this. 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
-7
View File
@@ -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
* *
+14 -14
View File
@@ -1,36 +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 {defaults as defaultControls} from '../src/ol/control.js'; goog.require('ol.control');
import TileLayer from '../src/ol/layer/Tile.js'; goog.require('ol.layer.Tile');
import OSM from '../src/ol/source/OSM.js'; 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',
controls: defaultControls({ controls: ol.control.defaults({
attributionOptions: { attributionOptions: {
collapsible: false collapsible: false
} }
}), }),
view: new View({ 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);
}; };
+29 -31
View File
@@ -1,27 +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 {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 // Improve user experience by loading tiles while animating. Will make
@@ -32,9 +32,7 @@ const map = new Map({
// 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 {
@@ -77,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
}); });
}); });
@@ -114,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) {
@@ -162,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);
+14 -12
View File
@@ -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
}) })
+1 -1
View File
@@ -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>
+13 -12
View File
@@ -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
}) })
+13 -12
View File
@@ -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);
} }
+2 -3
View File
@@ -3,11 +3,10 @@ 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">
+14 -14
View File
@@ -1,10 +1,10 @@
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', 'Road',
'RoadOnDemand', 'RoadOnDemand',
'Aerial', 'Aerial',
@@ -12,13 +12,13 @@ const styles = [
'collinsBart', '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
@@ -27,22 +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 // Improve user experience by loading tiles while dragging/zooming. Will make
// zooming choppy on mobile or slow devices. // zooming choppy on mobile or slow devices.
loadTilesWhileInteracting: true, 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);
} }
} }
+47 -44
View File
@@ -1,26 +1,29 @@
import Feature from '../src/ol/Feature.js'; goog.require('ol.Feature');
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import Point from '../src/ol/geom/Point.js'; goog.require('ol.geom.Point');
import VectorLayer from '../src/ol/layer/Vector.js'; goog.require('ol.layer.Vector');
import VectorSource from '../src/ol/source/Vector.js'; goog.require('ol.source.Vector');
import {Circle as CircleStyle, Fill, Stroke, Style} from '../src/ol/style.js'; 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. // Create separate layers for red, green an blue circles.
// //
// Every layer has one feature that is styled with a circle, together the // 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 // features form the corners of an equilateral triangle and their styles overlap
const redLayer = new VectorLayer({ var redLayer = new ol.layer.Vector({
source: new VectorSource({ source: new ol.source.Vector({
features: [new Feature(new Point([0, 0]))] features: [new ol.Feature(new ol.geom.Point([0, 0]))]
}), }),
style: new Style({ style: new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255,0,0,0.8)' color: 'rgba(255,0,0,0.8)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: 'rgb(255,0,0)', color: 'rgb(255,0,0)',
width: 15 width: 15
}), }),
@@ -28,17 +31,17 @@ const redLayer = new VectorLayer({
}) })
}) })
}); });
const greenLayer = new VectorLayer({ var greenLayer = new ol.layer.Vector({
source: new VectorSource({ source: new ol.source.Vector({
// 433.013 is roughly 250 * Math.sqrt(3) // 433.013 is roughly 250 * Math.sqrt(3)
features: [new Feature(new Point([250, 433.013]))] features: [new ol.Feature(new ol.geom.Point([250, 433.013]))]
}), }),
style: new Style({ style: new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(0,255,0,0.8)' color: 'rgba(0,255,0,0.8)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: 'rgb(0,255,0)', color: 'rgb(0,255,0)',
width: 15 width: 15
}), }),
@@ -46,16 +49,16 @@ const greenLayer = new VectorLayer({
}) })
}) })
}); });
const blueLayer = new VectorLayer({ var blueLayer = new ol.layer.Vector({
source: new VectorSource({ source: new ol.source.Vector({
features: [new Feature(new Point([500, 0]))] features: [new ol.Feature(new ol.geom.Point([500, 0]))]
}), }),
style: new Style({ style: new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(0,0,255,0.8)' color: 'rgba(0,0,255,0.8)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: 'rgb(0,0,255)', color: 'rgb(0,0,255)',
width: 15 width: 15
}), }),
@@ -66,14 +69,14 @@ const blueLayer = new VectorLayer({
// Create the map, the view is centered on the triangle. Zooming and panning is // Create the map, the view is centered on the triangle. Zooming and panning is
// restricted to a sane area // restricted to a sane area
const map = new Map({ var map = new ol.Map({
layers: [ layers: [
redLayer, redLayer,
greenLayer, greenLayer,
blueLayer blueLayer
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [250, 220], center: [250, 220],
extent: [0, 0, 500, 500], extent: [0, 0, 500, 500],
resolution: 4, resolution: 4,
@@ -83,19 +86,19 @@ const map = new Map({
}); });
// Get the form elements and bind the listeners // Get the form elements and bind the listeners
const select = document.getElementById('blend-mode'); var select = document.getElementById('blend-mode');
const affectRed = document.getElementById('affect-red'); var affectRed = document.getElementById('affect-red');
const affectGreen = document.getElementById('affect-green'); var affectGreen = document.getElementById('affect-green');
const affectBlue = document.getElementById('affect-blue'); var affectBlue = document.getElementById('affect-blue');
/** /**
* This method sets the globalCompositeOperation to the value of the select * This method sets the globalCompositeOperation to the value of the select
* field and it is bound to the precompose event of the layers. * field and it is bound to the precompose event of the layers.
* *
* @param {module:ol/render/Event~RenderEvent} evt The render event. * @param {ol.render.Event} evt The render event.
*/ */
const setBlendModeFromSelect = function(evt) { var setBlendModeFromSelect = function(evt) {
evt.context.globalCompositeOperation = select.value; evt.context.globalCompositeOperation = select.value;
}; };
@@ -104,9 +107,9 @@ const setBlendModeFromSelect = function(evt) {
* This method resets the globalCompositeOperation to the default value of * This method resets the globalCompositeOperation to the default value of
* 'source-over' and it is bound to the postcompose event of the layers. * 'source-over' and it is bound to the postcompose event of the layers.
* *
* @param {module:ol/render/Event~RenderEvent} evt The render event. * @param {ol.render.Event} evt The render event.
*/ */
const resetBlendModeFromSelect = function(evt) { var resetBlendModeFromSelect = function(evt) {
evt.context.globalCompositeOperation = 'source-over'; evt.context.globalCompositeOperation = 'source-over';
}; };
@@ -114,9 +117,9 @@ const resetBlendModeFromSelect = function(evt) {
/** /**
* Bind the pre- and postcompose handlers to the passed layer. * Bind the pre- and postcompose handlers to the passed layer.
* *
* @param {module:ol/layer/Vector} layer The layer to bind the handlers to. * @param {ol.layer.Vector} layer The layer to bind the handlers to.
*/ */
const bindLayerListeners = function(layer) { var bindLayerListeners = function(layer) {
layer.on('precompose', setBlendModeFromSelect); layer.on('precompose', setBlendModeFromSelect);
layer.on('postcompose', resetBlendModeFromSelect); layer.on('postcompose', resetBlendModeFromSelect);
}; };
@@ -125,9 +128,9 @@ const bindLayerListeners = function(layer) {
/** /**
* Unind the pre- and postcompose handlers to the passed layers. * Unind the pre- and postcompose handlers to the passed layers.
* *
* @param {module:ol/layer/Vector} layer The layer to unbind the handlers from. * @param {ol.layer.Vector} layer The layer to unbind the handlers from.
*/ */
const unbindLayerListeners = function(layer) { var unbindLayerListeners = function(layer) {
layer.un('precompose', setBlendModeFromSelect); layer.un('precompose', setBlendModeFromSelect);
layer.un('postcompose', resetBlendModeFromSelect); layer.un('postcompose', resetBlendModeFromSelect);
}; };
@@ -138,8 +141,8 @@ const unbindLayerListeners = function(layer) {
* *
* @this {HTMLInputElement} * @this {HTMLInputElement}
*/ */
const affectLayerClicked = function() { var affectLayerClicked = function() {
let layer; var layer;
if (this.id == 'affect-red') { if (this.id == 'affect-red') {
layer = redLayer; layer = redLayer;
} else if (this.id == 'affect-green') { } else if (this.id == 'affect-green') {
+1 -1
View File
@@ -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"
--- ---
+24 -21
View File
@@ -1,43 +1,46 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import {platformModifierKeyOnly} from '../src/ol/events/condition.js'; goog.require('ol.events.condition');
import GeoJSON from '../src/ol/format/GeoJSON.js'; goog.require('ol.format.GeoJSON');
import {DragBox, Select} from '../src/ol/interaction.js'; goog.require('ol.interaction.DragBox');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.interaction.Select');
import {OSM, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.layer.Tile');
goog.require('ol.layer.Vector');
goog.require('ol.source.OSM');
goog.require('ol.source.Vector');
const vectorSource = new VectorSource({ var vectorSource = new ol.source.Vector({
url: 'data/geojson/countries.geojson', url: 'data/geojson/countries.geojson',
format: new GeoJSON() format: new ol.format.GeoJSON()
}); });
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()
}), }),
new VectorLayer({ new ol.layer.Vector({
source: vectorSource source: vectorSource
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
}); });
// a normal select interaction to handle click // a normal select interaction to handle click
const select = new Select(); var select = new ol.interaction.Select();
map.addInteraction(select); map.addInteraction(select);
const selectedFeatures = select.getFeatures(); var selectedFeatures = select.getFeatures();
// a DragBox interaction used to select features by drawing boxes // a DragBox interaction used to select features by drawing boxes
const dragBox = new DragBox({ var dragBox = new ol.interaction.DragBox({
condition: platformModifierKeyOnly condition: ol.events.condition.platformModifierKeyOnly
}); });
map.addInteraction(dragBox); map.addInteraction(dragBox);
@@ -45,7 +48,7 @@ map.addInteraction(dragBox);
dragBox.on('boxend', function() { dragBox.on('boxend', function() {
// features that intersect the box are added to the collection of // features that intersect the box are added to the collection of
// selected features // selected features
const extent = dragBox.getGeometry().getExtent(); var extent = dragBox.getGeometry().getExtent();
vectorSource.forEachFeatureIntersectingExtent(extent, function(feature) { vectorSource.forEachFeatureIntersectingExtent(extent, function(feature) {
selectedFeatures.push(feature); selectedFeatures.push(feature);
}); });
@@ -56,10 +59,10 @@ dragBox.on('boxstart', function() {
selectedFeatures.clear(); selectedFeatures.clear();
}); });
const infoBox = document.getElementById('info'); var infoBox = document.getElementById('info');
selectedFeatures.on(['add', 'remove'], function() { selectedFeatures.on(['add', 'remove'], function() {
const names = selectedFeatures.getArray().map(function(feature) { var names = selectedFeatures.getArray().map(function(feature) {
return feature.get('name'); return feature.get('name');
}); });
if (names.length > 0) { if (names.length > 0) {
+8 -8
View File
@@ -1,16 +1,16 @@
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 from '../src/ol/source/OSM.js'; 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({ view: new ol.View({
center: [-8730000, 5930000], center: [-8730000, 5930000],
rotation: Math.PI / 5, rotation: Math.PI / 5,
zoom: 8 zoom: 8
+3 -4
View File
@@ -3,11 +3,10 @@ layout: example.html
title: Styling feature with CanvasGradient or CanvasPattern title: Styling feature with CanvasGradient or CanvasPattern
shortdesc: Example showing the countries vector layer styled with patterns and gradients. shortdesc: Example showing the countries vector layer styled with patterns and gradients.
docs: > docs: >
This example creates a [`CanvasPattern`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasPattern) First this example creates a reusable [`CanvasPattern`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasPattern)
and a [`CanvasGradient`](https://developer.mozilla.org/en/docs/Web/API/CanvasGradient). The countries are loaded from and a [`CanvasGradient`](https://developer.mozilla.org/en/docs/Web/API/CanvasGradient). The countries are loaded from
a GeoJSON file. A style function determines for each country whether to use a fill with the a GeoJSON file. A style function determines for each country whether to use a fill with the pregenerated
CanvasGradient (rainbow colors) or a CanvasPattern (repeating stacked circles). **Note**: For seamless repeat patterns, CanvasGradient (rainbow colors) or a CanvasPattern (repeating stacked circles).
image width and height of the pattern image must be a factor of two (2, 4, 8, ..., 512).
tags: "canvas, gradient, pattern, style" tags: "canvas, gradient, pattern, style"
--- ---
<div id="map" class="map"></div> <div id="map" class="map"></div>
+43 -33
View File
@@ -1,22 +1,31 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import GeoJSON from '../src/ol/format/GeoJSON.js'; goog.require('ol.extent');
import {DEVICE_PIXEL_RATIO} from '../src/ol/has.js'; goog.require('ol.format.GeoJSON');
import VectorLayer from '../src/ol/layer/Vector.js'; goog.require('ol.has');
import {fromLonLat} from '../src/ol/proj.js'; goog.require('ol.layer.Vector');
import VectorSource from '../src/ol/source/Vector.js'; goog.require('ol.proj');
import {Fill, Stroke, Style} from '../src/ol/style.js'; goog.require('ol.source.Vector');
goog.require('ol.style.Fill');
goog.require('ol.style.Stroke');
goog.require('ol.style.Style');
const canvas = document.createElement('canvas'); var canvas = document.createElement('canvas');
const context = canvas.getContext('2d'); var context = canvas.getContext('2d');
// Gradient and pattern are in canvas pixel space, so we adjust for the // Gradient and pattern are in canvas pixel space, so we adjust for the
// renderer's pixel ratio // renderer's pixel ratio
const pixelRatio = DEVICE_PIXEL_RATIO; var pixelRatio = ol.has.DEVICE_PIXEL_RATIO;
// Generate a rainbow gradient // Generate a rainbow gradient
const gradient = (function() { function gradient(feature, resolution) {
const grad = context.createLinearGradient(0, 0, 512 * pixelRatio, 0); var extent = feature.getGeometry().getExtent();
// Gradient starts on the left edge of each feature, and ends on the right.
// Coordinate origin is the top-left corner of the extent of the geometry, so
// we just divide the geometry's extent width by resolution and multiply with
// pixelRatio to match the renderer's pixel coordinate system.
var grad = context.createLinearGradient(0, 0,
ol.extent.getWidth(extent) / resolution * pixelRatio, 0);
grad.addColorStop(0, 'red'); grad.addColorStop(0, 'red');
grad.addColorStop(1 / 6, 'orange'); grad.addColorStop(1 / 6, 'orange');
grad.addColorStop(2 / 6, 'yellow'); grad.addColorStop(2 / 6, 'yellow');
@@ -25,33 +34,33 @@ const gradient = (function() {
grad.addColorStop(5 / 6, 'blue'); grad.addColorStop(5 / 6, 'blue');
grad.addColorStop(1, 'purple'); grad.addColorStop(1, 'purple');
return grad; return grad;
})(); }
// Generate a canvasPattern with two circles on white background // Generate a canvasPattern with two circles on white background
const pattern = (function() { var pattern = (function() {
canvas.width = 8 * pixelRatio; canvas.width = 11 * pixelRatio;
canvas.height = 8 * pixelRatio; canvas.height = 11 * pixelRatio;
// white background // white background
context.fillStyle = 'white'; context.fillStyle = 'white';
context.fillRect(0, 0, canvas.width, canvas.height); context.fillRect(0, 0, canvas.width, canvas.height);
// outer circle // outer circle
context.fillStyle = 'rgba(102, 0, 102, 0.5)'; context.fillStyle = 'rgba(102, 0, 102, 0.5)';
context.beginPath(); context.beginPath();
context.arc(4 * pixelRatio, 4 * pixelRatio, 3 * pixelRatio, 0, 2 * Math.PI); context.arc(5 * pixelRatio, 5 * pixelRatio, 4 * pixelRatio, 0, 2 * Math.PI);
context.fill(); context.fill();
// inner circle // inner circle
context.fillStyle = 'rgb(55, 0, 170)'; context.fillStyle = 'rgb(55, 0, 170)';
context.beginPath(); context.beginPath();
context.arc(4 * pixelRatio, 4 * pixelRatio, 1.5 * pixelRatio, 0, 2 * Math.PI); context.arc(5 * pixelRatio, 5 * pixelRatio, 2 * pixelRatio, 0, 2 * Math.PI);
context.fill(); context.fill();
return context.createPattern(canvas, 'repeat'); return context.createPattern(canvas, 'repeat');
}()); }());
// Generate style for gradient or pattern fill // Generate style for gradient or pattern fill
const fill = new Fill(); var fill = new ol.style.Fill();
const style = new Style({ var style = new ol.style.Style({
fill: fill, fill: fill,
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#333', color: '#333',
width: 2 width: 2
}) })
@@ -61,32 +70,33 @@ const style = new Style({
* The styling function for the vector layer, will return an array of styles * The styling function for the vector layer, will return an array of styles
* which either contains the aboove gradient or pattern. * which either contains the aboove gradient or pattern.
* *
* @param {module:ol/Feature~Feature} feature The feature to style. * @param {ol.Feature} feature The feature to style.
* @return {module:ol/style/Style} The style to use for the feature. * @param {number} resolution Resolution.
* @return {ol.style.Style} The style to use for the feature.
*/ */
const getStackedStyle = function(feature) { var getStackedStyle = function(feature, resolution) {
const id = feature.getId(); var id = feature.getId();
fill.setColor(id > 'J' ? gradient : pattern); fill.setColor(id > 'J' ? gradient(feature, resolution) : pattern);
return style; return style;
}; };
// Create a vector layer that makes use of the style function above… // Create a vector layer that makes use of the style function above…
const vectorLayer = new VectorLayer({ var vectorLayer = new ol.layer.Vector({
source: new VectorSource({ source: new ol.source.Vector({
url: 'data/geojson/countries.geojson', url: 'data/geojson/countries.geojson',
format: new GeoJSON() format: new ol.format.GeoJSON()
}), }),
style: getStackedStyle style: getStackedStyle
}); });
// … finally create a map with that layer. // … finally create a map with that layer.
const map = new Map({ var map = new ol.Map({
layers: [ layers: [
vectorLayer vectorLayer
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: fromLonLat([16, 48]), center: ol.proj.fromLonLat([7, 52]),
zoom: 3 zoom: 3
}) })
}); });
+16 -14
View File
@@ -1,32 +1,34 @@
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} from '../src/ol/control.js'; goog.require('ol.control');
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, TileDebug} from '../src/ol/source.js'; goog.require('ol.source.OSM');
goog.require('ol.source.TileDebug');
const osmSource = new OSM(); var osmSource = new ol.source.OSM();
const map = new Map({ var map = new ol.Map({
layers: [ layers: [
new TileLayer({ new ol.layer.Tile({
source: osmSource source: osmSource
}), }),
new TileLayer({ new ol.layer.Tile({
source: new TileDebug({ source: new ol.source.TileDebug({
projection: 'EPSG:3857', projection: 'EPSG:3857',
tileGrid: osmSource.getTileGrid() tileGrid: osmSource.getTileGrid()
}) })
}) })
], ],
target: 'map', target: 'map',
controls: defaultControls({ controls: ol.control.defaults({
attributionOptions: { attributionOptions: {
collapsible: false collapsible: false
} }
}), }),
view: new View({ view: new ol.View({
center: fromLonLat([-0.1275, 51.507222]), center: ol.proj.transform(
[-0.1275, 51.507222], 'EPSG:4326', 'EPSG:3857'),
zoom: 10 zoom: 10
}) })
}); });
+12 -11
View File
@@ -1,9 +1,10 @@
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 {CartoDB, OSM} from '../src/ol/source.js'; goog.require('ol.source.CartoDB');
goog.require('ol.source.OSM');
const mapConfig = { var mapConfig = {
'layers': [{ 'layers': [{
'type': 'cartodb', 'type': 'cartodb',
'options': { 'options': {
@@ -14,22 +15,22 @@ const mapConfig = {
}] }]
}; };
const cartoDBSource = new CartoDB({ var cartoDBSource = new ol.source.CartoDB({
account: 'documentation', account: 'documentation',
config: mapConfig config: mapConfig
}); });
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()
}), }),
new TileLayer({ new ol.layer.Tile({
source: cartoDBSource source: cartoDBSource
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
+42 -37
View File
@@ -1,51 +1,56 @@
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} from '../src/ol/control.js'; goog.require('ol.control');
import GeoJSON from '../src/ol/format/GeoJSON.js'; goog.require('ol.format.GeoJSON');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.layer.Tile');
import {OSM, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.layer.Vector');
import {Circle as CircleStyle, Fill, Stroke, Style} from '../src/ol/style.js'; goog.require('ol.source.OSM');
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');
const source = new VectorSource({ var source = new ol.source.Vector({
url: 'data/geojson/switzerland.geojson', url: 'data/geojson/switzerland.geojson',
format: new GeoJSON() format: new ol.format.GeoJSON()
}); });
const style = new Style({ var style = new ol.style.Style({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255, 255, 255, 0.6)' color: 'rgba(255, 255, 255, 0.6)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#319FD3', color: '#319FD3',
width: 1 width: 1
}), }),
image: new CircleStyle({ image: new ol.style.Circle({
radius: 5, radius: 5,
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255, 255, 255, 0.6)' color: 'rgba(255, 255, 255, 0.6)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#319FD3', color: '#319FD3',
width: 1 width: 1
}) })
}) })
}); });
const vectorLayer = new VectorLayer({ var vectorLayer = new ol.layer.Vector({
source: source, source: source,
style: style style: style
}); });
const view = new View({ var view = new ol.View({
center: [0, 0], center: [0, 0],
zoom: 1 zoom: 1
}); });
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()
}), }),
vectorLayer vectorLayer
], ],
target: 'map', target: 'map',
controls: defaultControls({ controls: ol.control.defaults({
attributionOptions: { attributionOptions: {
collapsible: false collapsible: false
} }
@@ -53,40 +58,40 @@ const map = new Map({
view: view view: view
}); });
const zoomtoswitzerlandbest = document.getElementById('zoomtoswitzerlandbest'); var zoomtoswitzerlandbest = document.getElementById('zoomtoswitzerlandbest');
zoomtoswitzerlandbest.addEventListener('click', function() { zoomtoswitzerlandbest.addEventListener('click', function() {
const feature = source.getFeatures()[0]; var feature = source.getFeatures()[0];
const polygon = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (feature.getGeometry()); var polygon = /** @type {ol.geom.SimpleGeometry} */ (feature.getGeometry());
view.fit(polygon, {padding: [170, 50, 30, 150], constrainResolution: false}); view.fit(polygon, {padding: [170, 50, 30, 150], constrainResolution: false});
}, false); }, false);
const zoomtoswitzerlandconstrained = var zoomtoswitzerlandconstrained =
document.getElementById('zoomtoswitzerlandconstrained'); document.getElementById('zoomtoswitzerlandconstrained');
zoomtoswitzerlandconstrained.addEventListener('click', function() { zoomtoswitzerlandconstrained.addEventListener('click', function() {
const feature = source.getFeatures()[0]; var feature = source.getFeatures()[0];
const polygon = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (feature.getGeometry()); var polygon = /** @type {ol.geom.SimpleGeometry} */ (feature.getGeometry());
view.fit(polygon, {padding: [170, 50, 30, 150]}); view.fit(polygon, {padding: [170, 50, 30, 150]});
}, false); }, false);
const zoomtoswitzerlandnearest = var zoomtoswitzerlandnearest =
document.getElementById('zoomtoswitzerlandnearest'); document.getElementById('zoomtoswitzerlandnearest');
zoomtoswitzerlandnearest.addEventListener('click', function() { zoomtoswitzerlandnearest.addEventListener('click', function() {
const feature = source.getFeatures()[0]; var feature = source.getFeatures()[0];
const polygon = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (feature.getGeometry()); var polygon = /** @type {ol.geom.SimpleGeometry} */ (feature.getGeometry());
view.fit(polygon, {padding: [170, 50, 30, 150], nearest: true}); view.fit(polygon, {padding: [170, 50, 30, 150], nearest: true});
}, false); }, false);
const zoomtolausanne = document.getElementById('zoomtolausanne'); var zoomtolausanne = document.getElementById('zoomtolausanne');
zoomtolausanne.addEventListener('click', function() { zoomtolausanne.addEventListener('click', function() {
const feature = source.getFeatures()[1]; var feature = source.getFeatures()[1];
const point = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (feature.getGeometry()); var point = /** @type {ol.geom.SimpleGeometry} */ (feature.getGeometry());
view.fit(point, {padding: [170, 50, 30, 150], minResolution: 50}); view.fit(point, {padding: [170, 50, 30, 150], minResolution: 50});
}, false); }, false);
const centerlausanne = document.getElementById('centerlausanne'); var centerlausanne = document.getElementById('centerlausanne');
centerlausanne.addEventListener('click', function() { centerlausanne.addEventListener('click', function() {
const feature = source.getFeatures()[1]; var feature = source.getFeatures()[1];
const point = /** @type {module:ol/geom/Point~Point} */ (feature.getGeometry()); var point = /** @type {ol.geom.Point} */ (feature.getGeometry());
const size = /** @type {module:ol/size~Size} */ (map.getSize()); var size = /** @type {ol.Size} */ (map.getSize());
view.centerOn(point.getCoordinates(), size, [570, 500]); view.centerOn(point.getCoordinates(), size, [570, 500]);
}, false); }, false);
-20
View File
@@ -1,20 +0,0 @@
---
layout: example.html
title: Smoothing lines using Chaikins algorithm
shortdesc: This uses Chaikins algorithm to smooth drawn lines.
docs: >
This example uses the npm package [`chaikin-smooth`](https://www.npmjs.com/package/chaikin-smooth) which
implements [Chaikins algorithm](http://graphics.cs.ucdavis.edu/education/CAGDNotes/Chaikins-Algorithm/Chaikins-Algorithm.html)
to smooth drawn lines.
Start by drawing on the map. Once you finish a drawing, the feature's geometry will be smoothed
as configured via the form elements.
tags: "smooth, smoothing, chaikin"
---
<div id="map" class="map"></div>
<form class="form-inline">
<label for="shall-smoothen">Smooth drawn geometry?</label>
<input id="shall-smoothen" type="checkbox" checked><br>
<label for="iterations">Number of smoothings</label>
<input style="width: 250px;" type="range" id="iterations" min="2" max="10" step="1" value="5">
</form>
-54
View File
@@ -1,54 +0,0 @@
import Map from '../src/ol/Map.js';
import View from '../src/ol/View.js';
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js';
import {OSM, Vector as VectorSource} from '../src/ol/source.js';
import Draw from '../src/ol/interaction/Draw.js';
import smooth from 'chaikin-smooth';
function makeSmooth(path, numIterations) {
numIterations = Math.min(Math.max(numIterations, 1), 10);
while (numIterations > 0) {
path = smooth(path);
numIterations--;
}
return path;
}
const vectorSource = new VectorSource({});
const map = new Map({
layers: [
new TileLayer({
source: new OSM(),
opacity: 0.5
}),
new VectorLayer({
source: vectorSource
})
],
target: 'map',
view: new View({
center: [1078373.5950, 6871994.5910],
zoom: 5
})
});
const shallSmoothen = document.getElementById('shall-smoothen');
const numIterations = document.getElementById('iterations');
const draw = new Draw({
source: vectorSource,
type: 'LineString'
});
map.addInteraction(draw);
draw.on('drawend', function(event) {
if (!shallSmoothen.checked) {
return;
}
const feat = event.feature;
const geometry = feat.getGeometry();
const coords = geometry.getCoordinates();
const smoothened = makeSmooth(coords, parseInt(numIterations.value, 10) || 5);
geometry.setCoordinates(smoothened);
});
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
layout: example.html layout: example.html
title: Clustered Features title: Clustered Features
shortdesc: Example of using ol/source/Cluster. shortdesc: Example of using ol.source.Cluster.
docs: > docs: >
This example shows how to do clustering on point features. This example shows how to do clustering on point features.
tags: "cluster, vector" tags: "cluster, vector"
+37 -30
View File
@@ -1,51 +1,58 @@
import Feature from '../src/ol/Feature.js'; goog.require('ol.Feature');
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import Point from '../src/ol/geom/Point.js'; goog.require('ol.geom.Point');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.layer.Tile');
import {Cluster, OSM, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.layer.Vector');
import {Circle as CircleStyle, Fill, Stroke, Style, Text} from '../src/ol/style.js'; goog.require('ol.source.Cluster');
goog.require('ol.source.OSM');
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');
goog.require('ol.style.Text');
const distance = document.getElementById('distance'); var distance = document.getElementById('distance');
const count = 20000; var count = 20000;
const features = new Array(count); var features = new Array(count);
const e = 4500000; var e = 4500000;
for (let i = 0; i < count; ++i) { for (var i = 0; i < count; ++i) {
const coordinates = [2 * e * Math.random() - e, 2 * e * Math.random() - e]; var coordinates = [2 * e * Math.random() - e, 2 * e * Math.random() - e];
features[i] = new Feature(new Point(coordinates)); features[i] = new ol.Feature(new ol.geom.Point(coordinates));
} }
const source = new VectorSource({ var source = new ol.source.Vector({
features: features features: features
}); });
const clusterSource = new Cluster({ var clusterSource = new ol.source.Cluster({
distance: parseInt(distance.value, 10), distance: parseInt(distance.value, 10),
source: source source: source
}); });
const styleCache = {}; var styleCache = {};
const clusters = new VectorLayer({ var clusters = new ol.layer.Vector({
source: clusterSource, source: clusterSource,
style: function(feature) { style: function(feature) {
const size = feature.get('features').length; var size = feature.get('features').length;
let style = styleCache[size]; var style = styleCache[size];
if (!style) { if (!style) {
style = new Style({ style = new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
radius: 10, radius: 10,
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#fff' color: '#fff'
}), }),
fill: new Fill({ fill: new ol.style.Fill({
color: '#3399CC' color: '#3399CC'
}) })
}), }),
text: new Text({ text: new ol.style.Text({
text: size.toString(), text: size.toString(),
fill: new Fill({ fill: new ol.style.Fill({
color: '#fff' color: '#fff'
}) })
}) })
@@ -56,14 +63,14 @@ const clusters = new VectorLayer({
} }
}); });
const raster = new TileLayer({ var raster = new ol.layer.Tile({
source: new OSM() source: new ol.source.OSM()
}); });
const map = new Map({ var map = new ol.Map({
layers: [raster, clusters], layers: [raster, clusters],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
+49 -47
View File
@@ -1,21 +1,23 @@
import Map from '../src/ol/Map.js'; // NOCOMPILE
import View from '../src/ol/View.js'; goog.require('ol.Map');
import ImageLayer from '../src/ol/layer/Image.js'; goog.require('ol.View');
import {Raster as RasterSource, Stamen} from '../src/ol/source.js'; goog.require('ol.layer.Image');
goog.require('ol.source.Raster');
goog.require('ol.source.Stamen');
/** /**
* Color manipulation functions below are adapted from * Color manipulation functions below are adapted from
* https://github.com/d3/d3-color. * https://github.com/d3/d3-color.
*/ */
const Xn = 0.950470; var Xn = 0.950470;
const Yn = 1; var Yn = 1;
const Zn = 1.088830; var Zn = 1.088830;
const t0 = 4 / 29; var t0 = 4 / 29;
const t1 = 6 / 29; var t1 = 6 / 29;
const t2 = 3 * t1 * t1; var t2 = 3 * t1 * t1;
const t3 = t1 * t1 * t1; var t3 = t1 * t1 * t1;
const twoPi = 2 * Math.PI; var twoPi = 2 * Math.PI;
/** /**
@@ -24,23 +26,23 @@ const twoPi = 2 * Math.PI;
* @return {Array.<number>} A pixel in HCL space. * @return {Array.<number>} A pixel in HCL space.
*/ */
function rgb2hcl(pixel) { function rgb2hcl(pixel) {
const red = rgb2xyz(pixel[0]); var red = rgb2xyz(pixel[0]);
const green = rgb2xyz(pixel[1]); var green = rgb2xyz(pixel[1]);
const blue = rgb2xyz(pixel[2]); var blue = rgb2xyz(pixel[2]);
const x = xyz2lab( var x = xyz2lab(
(0.4124564 * red + 0.3575761 * green + 0.1804375 * blue) / Xn); (0.4124564 * red + 0.3575761 * green + 0.1804375 * blue) / Xn);
const y = xyz2lab( var y = xyz2lab(
(0.2126729 * red + 0.7151522 * green + 0.0721750 * blue) / Yn); (0.2126729 * red + 0.7151522 * green + 0.0721750 * blue) / Yn);
const z = xyz2lab( var z = xyz2lab(
(0.0193339 * red + 0.1191920 * green + 0.9503041 * blue) / Zn); (0.0193339 * red + 0.1191920 * green + 0.9503041 * blue) / Zn);
const l = 116 * y - 16; var l = 116 * y - 16;
const a = 500 * (x - y); var a = 500 * (x - y);
const b = 200 * (y - z); var b = 200 * (y - z);
const c = Math.sqrt(a * a + b * b); var c = Math.sqrt(a * a + b * b);
let h = Math.atan2(b, a); var h = Math.atan2(b, a);
if (h < 0) { if (h < 0) {
h += twoPi; h += twoPi;
} }
@@ -59,16 +61,16 @@ function rgb2hcl(pixel) {
* @return {Array.<number>} A pixel in RGB space. * @return {Array.<number>} A pixel in RGB space.
*/ */
function hcl2rgb(pixel) { function hcl2rgb(pixel) {
const h = pixel[0]; var h = pixel[0];
const c = pixel[1]; var c = pixel[1];
const l = pixel[2]; var l = pixel[2];
const a = Math.cos(h) * c; var a = Math.cos(h) * c;
const b = Math.sin(h) * c; var b = Math.sin(h) * c;
let y = (l + 16) / 116; var y = (l + 16) / 116;
let x = isNaN(a) ? y : y + a / 500; var x = isNaN(a) ? y : y + a / 500;
let z = isNaN(b) ? y : y - b / 200; var z = isNaN(b) ? y : y - b / 200;
y = Yn * lab2xyz(y); y = Yn * lab2xyz(y);
x = Xn * lab2xyz(x); x = Xn * lab2xyz(x);
@@ -98,15 +100,15 @@ function xyz2rgb(x) {
12.92 * x : 1.055 * Math.pow(x, 1 / 2.4) - 0.055); 12.92 * x : 1.055 * Math.pow(x, 1 / 2.4) - 0.055);
} }
const raster = new RasterSource({ var raster = new ol.source.Raster({
sources: [new Stamen({ sources: [new ol.source.Stamen({
layer: 'watercolor', layer: 'watercolor',
transition: 0 transition: 0
})], })],
operation: function(pixels, data) { operation: function(pixels, data) {
const hcl = rgb2hcl(pixels[0]); var hcl = rgb2hcl(pixels[0]);
let h = hcl[0] + Math.PI * data.hue / 180; var h = hcl[0] + Math.PI * data.hue / 180;
if (h < 0) { if (h < 0) {
h += twoPi; h += twoPi;
} else if (h > twoPi) { } else if (h > twoPi) {
@@ -137,33 +139,33 @@ const raster = new RasterSource({
} }
}); });
const controls = {}; var controls = {};
raster.on('beforeoperations', function(event) { raster.on('beforeoperations', function(event) {
const data = event.data; var data = event.data;
for (const id in controls) { for (var id in controls) {
data[id] = Number(controls[id].value); data[id] = Number(controls[id].value);
} }
}); });
const map = new Map({ var map = new ol.Map({
layers: [ layers: [
new ImageLayer({ new ol.layer.Image({
source: raster source: raster
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 2500000], center: [0, 2500000],
zoom: 2, zoom: 2,
maxZoom: 18 maxZoom: 18
}) })
}); });
const controlIds = ['hue', 'chroma', 'lightness']; var controlIds = ['hue', 'chroma', 'lightness'];
controlIds.forEach(function(id) { controlIds.forEach(function(id) {
const control = document.getElementById(id); var control = document.getElementById(id);
const output = document.getElementById(id + 'Out'); var output = document.getElementById(id + 'Out');
control.addEventListener('input', function() { control.addEventListener('input', function() {
output.innerText = control.value; output.innerText = control.value;
raster.changed(); raster.changed();
+21 -20
View File
@@ -1,16 +1,17 @@
import {inherits} from '../src/ol/index.js'; goog.require('ol');
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, Control} from '../src/ol/control.js'; goog.require('ol.control');
import TileLayer from '../src/ol/layer/Tile.js'; goog.require('ol.control.Control');
import OSM from '../src/ol/source/OSM.js'; goog.require('ol.layer.Tile');
goog.require('ol.source.OSM');
/** /**
* Define a namespace for the application. * Define a namespace for the application.
*/ */
window.app = {}; window.app = {};
const app = window.app; var app = window.app;
// //
@@ -20,35 +21,35 @@ const app = window.app;
/** /**
* @constructor * @constructor
* @extends {module:ol/control/Control~Control} * @extends {ol.control.Control}
* @param {Object=} opt_options Control options. * @param {Object=} opt_options Control options.
*/ */
app.RotateNorthControl = function(opt_options) { app.RotateNorthControl = function(opt_options) {
const options = opt_options || {}; var options = opt_options || {};
const button = document.createElement('button'); var button = document.createElement('button');
button.innerHTML = 'N'; button.innerHTML = 'N';
const this_ = this; var this_ = this;
const handleRotateNorth = function() { var handleRotateNorth = function() {
this_.getMap().getView().setRotation(0); this_.getMap().getView().setRotation(0);
}; };
button.addEventListener('click', handleRotateNorth, false); button.addEventListener('click', handleRotateNorth, false);
button.addEventListener('touchstart', handleRotateNorth, false); button.addEventListener('touchstart', handleRotateNorth, false);
const element = document.createElement('div'); var element = document.createElement('div');
element.className = 'rotate-north ol-unselectable ol-control'; element.className = 'rotate-north ol-unselectable ol-control';
element.appendChild(button); element.appendChild(button);
Control.call(this, { ol.control.Control.call(this, {
element: element, element: element,
target: options.target target: options.target
}); });
}; };
inherits(app.RotateNorthControl, Control); ol.inherits(app.RotateNorthControl, ol.control.Control);
// //
@@ -56,8 +57,8 @@ inherits(app.RotateNorthControl, Control);
// //
const map = new Map({ var map = new ol.Map({
controls: defaultControls({ controls: ol.control.defaults({
attributionOptions: { attributionOptions: {
collapsible: false collapsible: false
} }
@@ -65,12 +66,12 @@ const map = new Map({
new app.RotateNorthControl() new app.RotateNorthControl()
]), ]),
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: [0, 0], center: [0, 0],
zoom: 3, zoom: 3,
rotation: 1 rotation: 1
+9
View File
@@ -0,0 +1,9 @@
---
layout: example.html
title: Custom Icon
shortdesc: Example using a custom attribution icon object
docs: >
This example creates a custom element for the attribution icon
tags: "icon, element"
---
<div id="map" class="map"><div id="popup"></div></div>
+27
View File
@@ -0,0 +1,27 @@
goog.require('ol.Map');
goog.require('ol.View');
goog.require('ol.layer.Tile');
goog.require('ol.source.OSM');
var logoElement = document.createElement('a');
logoElement.href = 'https://www.osgeo.org/';
logoElement.target = '_blank';
var logoImage = document.createElement('img');
logoImage.src = 'https://www.osgeo.org/sites/all/themes/osgeo/logo.png';
logoElement.appendChild(logoImage);
var map = new ol.Map({
layers: [
new ol.layer.Tile({
source: new ol.source.OSM()
})
],
target: 'map',
view: new ol.View({
center: [0, 0],
zoom: 2
}),
logo: logoElement
});
+2 -2
View File
@@ -3,8 +3,8 @@ layout: example.html
title: Custom Interactions title: Custom Interactions
shortdesc: Example of a custom interaction. shortdesc: Example of a custom interaction.
docs: > docs: >
This example demonstrates creating a custom interaction by subclassing `ol/interaction/Pointer`. This example demonstrates creating a custom interaction by subclassing `ol.interaction.Pointer`.
Note that the built in interaction `ol/interaction/Translate` might be a better option for moving features. Note that the built in interaction `ol.interaction.Translate` might be a better option for moving features.
tags: "drag, feature, vector, editing, custom, interaction" tags: "drag, feature, vector, editing, custom, interaction"
--- ---
<div id="map" class="map"></div> <div id="map" class="map"></div>
+57 -49
View File
@@ -1,27 +1,35 @@
import {inherits} from '../src/ol/index.js'; goog.require('ol');
import Feature from '../src/ol/Feature.js'; goog.require('ol.Feature');
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import {LineString, Point, Polygon} from '../src/ol/geom.js'; goog.require('ol.geom.LineString');
import {defaults as defaultInteractions, Pointer as PointerInteraction} from '../src/ol/interaction.js'; goog.require('ol.geom.Point');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.geom.Polygon');
import {TileJSON, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.interaction');
import {Fill, Icon, Stroke, Style} from '../src/ol/style.js'; goog.require('ol.interaction.Pointer');
goog.require('ol.layer.Tile');
goog.require('ol.layer.Vector');
goog.require('ol.source.TileJSON');
goog.require('ol.source.Vector');
goog.require('ol.style.Fill');
goog.require('ol.style.Icon');
goog.require('ol.style.Stroke');
goog.require('ol.style.Style');
/** /**
* Define a namespace for the application. * Define a namespace for the application.
*/ */
const app = {}; var app = {};
/** /**
* @constructor * @constructor
* @extends {module:ol/interaction/Pointer} * @extends {ol.interaction.Pointer}
*/ */
app.Drag = function() { app.Drag = function() {
PointerInteraction.call(this, { ol.interaction.Pointer.call(this, {
handleDownEvent: app.Drag.prototype.handleDownEvent, handleDownEvent: app.Drag.prototype.handleDownEvent,
handleDragEvent: app.Drag.prototype.handleDragEvent, handleDragEvent: app.Drag.prototype.handleDragEvent,
handleMoveEvent: app.Drag.prototype.handleMoveEvent, handleMoveEvent: app.Drag.prototype.handleMoveEvent,
@@ -29,7 +37,7 @@ app.Drag = function() {
}); });
/** /**
* @type {module:ol~Pixel} * @type {ol.Pixel}
* @private * @private
*/ */
this.coordinate_ = null; this.coordinate_ = null;
@@ -41,7 +49,7 @@ app.Drag = function() {
this.cursor_ = 'pointer'; this.cursor_ = 'pointer';
/** /**
* @type {module:ol/Feature~Feature} * @type {ol.Feature}
* @private * @private
*/ */
this.feature_ = null; this.feature_ = null;
@@ -53,20 +61,20 @@ app.Drag = function() {
this.previousCursor_ = undefined; this.previousCursor_ = undefined;
}; };
inherits(app.Drag, PointerInteraction); ol.inherits(app.Drag, ol.interaction.Pointer);
/** /**
* @param {module:ol/MapBrowserEvent~MapBrowserEvent} evt Map browser event. * @param {ol.MapBrowserEvent} evt Map browser event.
* @return {boolean} `true` to start the drag sequence. * @return {boolean} `true` to start the drag sequence.
*/ */
app.Drag.prototype.handleDownEvent = function(evt) { app.Drag.prototype.handleDownEvent = function(evt) {
const map = evt.map; var map = evt.map;
const feature = map.forEachFeatureAtPixel(evt.pixel, var feature = map.forEachFeatureAtPixel(evt.pixel,
function(feature) { function(feature) {
return feature; return feature;
}); });
if (feature) { if (feature) {
this.coordinate_ = evt.coordinate; this.coordinate_ = evt.coordinate;
@@ -78,13 +86,13 @@ app.Drag.prototype.handleDownEvent = function(evt) {
/** /**
* @param {module:ol/MapBrowserEvent~MapBrowserEvent} evt Map browser event. * @param {ol.MapBrowserEvent} evt Map browser event.
*/ */
app.Drag.prototype.handleDragEvent = function(evt) { app.Drag.prototype.handleDragEvent = function(evt) {
const deltaX = evt.coordinate[0] - this.coordinate_[0]; var deltaX = evt.coordinate[0] - this.coordinate_[0];
const deltaY = evt.coordinate[1] - this.coordinate_[1]; var deltaY = evt.coordinate[1] - this.coordinate_[1];
const geometry = this.feature_.getGeometry(); var geometry = this.feature_.getGeometry();
geometry.translate(deltaX, deltaY); geometry.translate(deltaX, deltaY);
this.coordinate_[0] = evt.coordinate[0]; this.coordinate_[0] = evt.coordinate[0];
@@ -93,16 +101,16 @@ app.Drag.prototype.handleDragEvent = function(evt) {
/** /**
* @param {module:ol/MapBrowserEvent~MapBrowserEvent} evt Event. * @param {ol.MapBrowserEvent} evt Event.
*/ */
app.Drag.prototype.handleMoveEvent = function(evt) { app.Drag.prototype.handleMoveEvent = function(evt) {
if (this.cursor_) { if (this.cursor_) {
const map = evt.map; var map = evt.map;
const feature = map.forEachFeatureAtPixel(evt.pixel, var feature = map.forEachFeatureAtPixel(evt.pixel,
function(feature) { function(feature) {
return feature; return feature;
}); });
const element = evt.map.getTargetElement(); var element = evt.map.getTargetElement();
if (feature) { if (feature) {
if (element.style.cursor != this.cursor_) { if (element.style.cursor != this.cursor_) {
this.previousCursor_ = element.style.cursor; this.previousCursor_ = element.style.cursor;
@@ -126,48 +134,48 @@ app.Drag.prototype.handleUpEvent = function() {
}; };
const pointFeature = new Feature(new Point([0, 0])); var pointFeature = new ol.Feature(new ol.geom.Point([0, 0]));
const lineFeature = new Feature( var lineFeature = new ol.Feature(
new LineString([[-1e7, 1e6], [-1e6, 3e6]])); new ol.geom.LineString([[-1e7, 1e6], [-1e6, 3e6]]));
const polygonFeature = new Feature( var polygonFeature = new ol.Feature(
new Polygon([[[-3e6, -1e6], [-3e6, 1e6], new ol.geom.Polygon([[[-3e6, -1e6], [-3e6, 1e6],
[-1e6, 1e6], [-1e6, -1e6], [-3e6, -1e6]]])); [-1e6, 1e6], [-1e6, -1e6], [-3e6, -1e6]]]));
const map = new Map({ var map = new ol.Map({
interactions: defaultInteractions().extend([new app.Drag()]), interactions: ol.interaction.defaults().extend([new app.Drag()]),
layers: [ layers: [
new TileLayer({ new ol.layer.Tile({
source: new TileJSON({ source: new ol.source.TileJSON({
url: 'https://api.tiles.mapbox.com/v3/mapbox.geography-class.json?secure' url: 'https://api.tiles.mapbox.com/v3/mapbox.geography-class.json?secure'
}) })
}), }),
new VectorLayer({ new ol.layer.Vector({
source: new VectorSource({ source: new ol.source.Vector({
features: [pointFeature, lineFeature, polygonFeature] features: [pointFeature, lineFeature, polygonFeature]
}), }),
style: new Style({ style: new ol.style.Style({
image: new Icon(/** @type {module:ol/style/Icon~Options} */ ({ image: new ol.style.Icon(/** @type {olx.style.IconOptions} */ ({
anchor: [0.5, 46], anchor: [0.5, 46],
anchorXUnits: 'fraction', anchorXUnits: 'fraction',
anchorYUnits: 'pixels', anchorYUnits: 'pixels',
opacity: 0.95, opacity: 0.95,
src: 'data/icon.png' src: 'data/icon.png'
})), })),
stroke: new Stroke({ stroke: new ol.style.Stroke({
width: 3, width: 3,
color: [255, 0, 0, 1] color: [255, 0, 0, 1]
}), }),
fill: new Fill({ fill: new ol.style.Fill({
color: [0, 0, 255, 0.6] color: [0, 0, 255, 0.6]
}) })
}) })
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
+2 -2
View File
@@ -6,7 +6,7 @@ docs: >
<p>The example loads TopoJSON geometries and uses d3 (<code>d3.geo.path</code>) to render these geometries to a canvas element that is then used as the image of an OpenLayers image layer.</p> <p>The example loads TopoJSON geometries and uses d3 (<code>d3.geo.path</code>) to render these geometries to a canvas element that is then used as the image of an OpenLayers image layer.</p>
tags: "d3" tags: "d3"
resources: resources:
- https://unpkg.com/d3@4.12.0/build/d3.js - https://d3js.org/d3.v3.min.js
- https://unpkg.com/topojson@3.0.2/dist/topojson.js - https://d3js.org/topojson.v1.min.js
--- ---
<div id="map" class="map"></div> <div id="map" class="map"></div>
+48 -41
View File
@@ -1,84 +1,91 @@
import Map from '../src/ol/Map.js'; // NOCOMPILE
import View from '../src/ol/View.js'; goog.require('ol.Map');
import {getWidth, getCenter} from '../src/ol/extent.js'; goog.require('ol.View');
import {Image as ImageLayer, Tile as TileLayer} from '../src/ol/layer.js'; goog.require('ol.extent');
import {fromLonLat, toLonLat} from '../src/ol/proj.js'; goog.require('ol.layer.Image');
import {ImageCanvas as ImageCanvasSource, Stamen} from '../src/ol/source.js'; goog.require('ol.layer.Tile');
goog.require('ol.proj');
goog.require('ol.source.ImageCanvas');
goog.require('ol.source.Stamen');
const map = new Map({ var map = new ol.Map({
layers: [ layers: [
new TileLayer({ new ol.layer.Tile({
source: new Stamen({ source: new ol.source.Stamen({
layer: 'watercolor' layer: 'watercolor'
}) })
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: fromLonLat([-97, 38]), center: ol.proj.fromLonLat([-97, 38]),
zoom: 4 zoom: 4
}) })
}); });
/** /**
* Load the topojson data and create an ol/layer/Image for that data. * Load the topojson data and create an ol.layer.Image for that data.
*/ */
d3.json('data/topojson/us.json', function(error, us) { d3.json('data/topojson/us.json', function(error, us) {
const features = topojson.feature(us, us.objects.counties); var features = topojson.feature(us, us.objects.counties);
/** /**
* This function uses d3 to render the topojson features to a canvas. * This function uses d3 to render the topojson features to a canvas.
* @param {module:ol/extent~Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {module:ol/size~Size} size Size. * @param {ol.Size} size Size.
* @param {module:ol/proj/Projection~Projection} projection Projection. * @param {ol.proj.Projection} projection Projection.
* @return {HTMLCanvasElement} A canvas element. * @return {HTMLCanvasElement} A canvas element.
*/ */
const canvasFunction = function(extent, resolution, pixelRatio, size, projection) { var canvasFunction = function(extent, resolution, pixelRatio,
const canvasWidth = size[0]; size, projection) {
const canvasHeight = size[1]; var canvasWidth = size[0];
var canvasHeight = size[1];
const canvas = d3.select(document.createElement('canvas')); var canvas = d3.select(document.createElement('canvas'));
canvas.attr('width', canvasWidth).attr('height', canvasHeight); canvas.attr('width', canvasWidth).attr('height', canvasHeight);
const context = canvas.node().getContext('2d'); var context = canvas.node().getContext('2d');
const d3Projection = d3.geoMercator().scale(1).translate([0, 0]); var d3Projection = d3.geo.mercator().scale(1).translate([0, 0]);
let d3Path = d3.geoPath().projection(d3Projection); var d3Path = d3.geo.path().projection(d3Projection);
const pixelBounds = d3Path.bounds(features); var pixelBounds = d3Path.bounds(features);
const pixelBoundsWidth = pixelBounds[1][0] - pixelBounds[0][0]; var pixelBoundsWidth = pixelBounds[1][0] - pixelBounds[0][0];
const pixelBoundsHeight = pixelBounds[1][1] - pixelBounds[0][1]; var pixelBoundsHeight = pixelBounds[1][1] - pixelBounds[0][1];
const geoBounds = d3.geoBounds(features); var geoBounds = d3.geo.bounds(features);
const geoBoundsLeftBottom = fromLonLat(geoBounds[0], projection); var geoBoundsLeftBottom = ol.proj.transform(
const geoBoundsRightTop = fromLonLat(geoBounds[1], projection); geoBounds[0], 'EPSG:4326', projection);
let geoBoundsWidth = geoBoundsRightTop[0] - geoBoundsLeftBottom[0]; var geoBoundsRightTop = ol.proj.transform(
geoBounds[1], 'EPSG:4326', projection);
var geoBoundsWidth = geoBoundsRightTop[0] - geoBoundsLeftBottom[0];
if (geoBoundsWidth < 0) { if (geoBoundsWidth < 0) {
geoBoundsWidth += getWidth(projection.getExtent()); geoBoundsWidth += ol.extent.getWidth(projection.getExtent());
} }
const geoBoundsHeight = geoBoundsRightTop[1] - geoBoundsLeftBottom[1]; var geoBoundsHeight = geoBoundsRightTop[1] - geoBoundsLeftBottom[1];
const widthResolution = geoBoundsWidth / pixelBoundsWidth; var widthResolution = geoBoundsWidth / pixelBoundsWidth;
const heightResolution = geoBoundsHeight / pixelBoundsHeight; var heightResolution = geoBoundsHeight / pixelBoundsHeight;
const r = Math.max(widthResolution, heightResolution); var r = Math.max(widthResolution, heightResolution);
const scale = r / (resolution / pixelRatio); var scale = r / (resolution / pixelRatio);
const center = toLonLat(getCenter(extent), projection); var center = ol.proj.transform(ol.extent.getCenter(extent),
projection, 'EPSG:4326');
d3Projection.scale(scale).center(center) d3Projection.scale(scale).center(center)
.translate([canvasWidth / 2, canvasHeight / 2]); .translate([canvasWidth / 2, canvasHeight / 2]);
d3Path = d3Path.projection(d3Projection).context(context); d3Path = d3Path.projection(d3Projection).context(context);
d3Path(features); d3Path(features);
context.stroke(); context.stroke();
return canvas.node(); return canvas[0][0];
}; };
const layer = new ImageLayer({ var layer = new ol.layer.Image({
source: new ImageCanvasSource({ source: new ol.source.ImageCanvas({
canvasFunction: canvasFunction, canvasFunction: canvasFunction,
projection: 'EPSG:3857' projection: 'EPSG:3857'
}) })
+22 -17
View File
@@ -1,22 +1,27 @@
import Map from '../src/ol/Map.js'; // NOCOMPILE
import View from '../src/ol/View.js'; goog.require('ol.Map');
import {defaults as defaultControls} from '../src/ol/control.js'; goog.require('ol.View');
import TileLayer from '../src/ol/layer/Tile.js'; goog.require('ol.control');
import {toRadians} from '../src/ol/math.js'; goog.require('ol.layer.Tile');
import OSM from '../src/ol/source/OSM.js'; goog.require('ol.math');
goog.require('ol.proj');
goog.require('ol.source.OSM');
const view = new View({ var projection = ol.proj.get('EPSG:3857');
var view = new ol.View({
center: [0, 0], center: [0, 0],
projection: projection,
extent: projection.getExtent(),
zoom: 2 zoom: 2
}); });
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',
controls: defaultControls({ controls: ol.control.defaults({
attributionOptions: { attributionOptions: {
collapsible: false collapsible: false
} }
@@ -29,15 +34,15 @@ function el(id) {
} }
const gn = new GyroNorm(); var gn = new GyroNorm();
gn.init().then(function() { gn.init().then(function() {
gn.start(function(event) { gn.start(function(event) {
const center = view.getCenter(); var center = view.getCenter();
const resolution = view.getResolution(); var resolution = view.getResolution();
const alpha = toRadians(event.do.beta); var alpha = ol.math.toRadians(event.do.beta);
const beta = toRadians(event.do.beta); var beta = ol.math.toRadians(event.do.beta);
const gamma = toRadians(event.do.gamma); var gamma = ol.math.toRadians(event.do.gamma);
el('alpha').innerText = alpha + ' [rad]'; el('alpha').innerText = alpha + ' [rad]';
el('beta').innerText = beta + ' [rad]'; el('beta').innerText = beta + ' [rad]';
+2 -3
View File
@@ -3,11 +3,10 @@ layout: example.html
title: Drag-and-Drop Image Vector title: Drag-and-Drop Image Vector
shortdesc: Example of using the drag-and-drop interaction with image vector rendering. shortdesc: Example of using the drag-and-drop interaction with image vector rendering.
docs: > docs: >
Example of using the drag-and-drop interaction with an `ol/layer/Vector` with `renderMode: 'image'``. Drag and drop GPX, GeoJSON, IGC, KML, or TopoJSON files on to the map. Each file is rendered to an image on the client. Example of using the drag-and-drop interaction with an `ol.layer.Vector` with `renderMode: 'image'``. Drag and drop GPX, GeoJSON, IGC, KML, or TopoJSON files on to the map. Each file is rendered to an image on the client.
tags: "drag-and-drop-image-vector, gpx, geojson, igc, kml, topojson, vector, image" tags: "drag-and-drop-image-vector, gpx, geojson, igc, kml, topojson, vector, image"
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>
<div id="info">&nbsp;</div> <div id="info">&nbsp;</div>
+56 -46
View File
@@ -1,71 +1,81 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import {GPX, GeoJSON, IGC, KML, TopoJSON} from '../src/ol/format.js'; goog.require('ol.format.GPX');
import {defaults as defaultInteractions, DragAndDrop} from '../src/ol/interaction.js'; goog.require('ol.format.GeoJSON');
import {Vector as VectorLayer, Tile as TileLayer} from '../src/ol/layer.js'; goog.require('ol.format.IGC');
import {BingMaps, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.format.KML');
import {Circle as CircleStyle, Fill, Stroke, Style} from '../src/ol/style.js'; goog.require('ol.format.TopoJSON');
goog.require('ol.interaction');
goog.require('ol.interaction.DragAndDrop');
goog.require('ol.layer.Vector');
goog.require('ol.layer.Tile');
goog.require('ol.source.BingMaps');
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');
const defaultStyle = { var defaultStyle = {
'Point': new Style({ 'Point': new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255,255,0,0.5)' color: 'rgba(255,255,0,0.5)'
}), }),
radius: 5, radius: 5,
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#ff0', color: '#ff0',
width: 1 width: 1
}) })
}) })
}), }),
'LineString': new Style({ 'LineString': new ol.style.Style({
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#f00', color: '#f00',
width: 3 width: 3
}) })
}), }),
'Polygon': new Style({ 'Polygon': new ol.style.Style({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(0,255,255,0.5)' color: 'rgba(0,255,255,0.5)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#0ff', color: '#0ff',
width: 1 width: 1
}) })
}), }),
'MultiPoint': new Style({ 'MultiPoint': new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255,0,255,0.5)' color: 'rgba(255,0,255,0.5)'
}), }),
radius: 5, radius: 5,
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#f0f', color: '#f0f',
width: 1 width: 1
}) })
}) })
}), }),
'MultiLineString': new Style({ 'MultiLineString': new ol.style.Style({
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#0f0', color: '#0f0',
width: 3 width: 3
}) })
}), }),
'MultiPolygon': new Style({ 'MultiPolygon': new ol.style.Style({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(0,0,255,0.5)' color: 'rgba(0,0,255,0.5)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#00f', color: '#00f',
width: 1 width: 1
}) })
}) })
}; };
const styleFunction = function(feature, resolution) { var styleFunction = function(feature, resolution) {
const featureStyleFunction = feature.getStyleFunction(); var featureStyleFunction = feature.getStyleFunction();
if (featureStyleFunction) { if (featureStyleFunction) {
return featureStyleFunction.call(feature, resolution); return featureStyleFunction.call(feature, resolution);
} else { } else {
@@ -73,38 +83,38 @@ const styleFunction = function(feature, resolution) {
} }
}; };
const dragAndDropInteraction = new DragAndDrop({ var dragAndDropInteraction = new ol.interaction.DragAndDrop({
formatConstructors: [ formatConstructors: [
GPX, ol.format.GPX,
GeoJSON, ol.format.GeoJSON,
IGC, ol.format.IGC,
KML, ol.format.KML,
TopoJSON ol.format.TopoJSON
] ]
}); });
const map = new Map({ var map = new ol.Map({
interactions: defaultInteractions().extend([dragAndDropInteraction]), interactions: ol.interaction.defaults().extend([dragAndDropInteraction]),
layers: [ layers: [
new TileLayer({ new ol.layer.Tile({
source: new BingMaps({ source: new ol.source.BingMaps({
imagerySet: 'Aerial', imagerySet: 'Aerial',
key: 'As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5' key: 'As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5'
}) })
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
}); });
dragAndDropInteraction.on('addfeatures', function(event) { dragAndDropInteraction.on('addfeatures', function(event) {
const vectorSource = new VectorSource({ var vectorSource = new ol.source.Vector({
features: event.features features: event.features
}); });
map.addLayer(new VectorLayer({ map.addLayer(new ol.layer.Vector({
renderMode: 'image', renderMode: 'image',
source: vectorSource, source: vectorSource,
style: styleFunction style: styleFunction
@@ -112,14 +122,14 @@ dragAndDropInteraction.on('addfeatures', function(event) {
map.getView().fit(vectorSource.getExtent()); map.getView().fit(vectorSource.getExtent());
}); });
const displayFeatureInfo = function(pixel) { var displayFeatureInfo = function(pixel) {
const features = []; var features = [];
map.forEachFeatureAtPixel(pixel, function(feature) { map.forEachFeatureAtPixel(pixel, function(feature) {
features.push(feature); features.push(feature);
}); });
if (features.length > 0) { if (features.length > 0) {
const info = []; var info = [];
let i, ii; var i, ii;
for (i = 0, ii = features.length; i < ii; ++i) { for (i = 0, ii = features.length; i < ii; ++i) {
info.push(features[i].get('name')); info.push(features[i].get('name'));
} }
@@ -133,7 +143,7 @@ map.on('pointermove', function(evt) {
if (evt.dragging) { if (evt.dragging) {
return; return;
} }
const pixel = map.getEventPixel(evt.originalEvent); var pixel = map.getEventPixel(evt.originalEvent);
displayFeatureInfo(pixel); displayFeatureInfo(pixel);
}); });
+1 -2
View File
@@ -6,8 +6,7 @@ docs: >
Example of using the drag-and-drop interaction. Drag and drop GPX, GeoJSON, IGC, KML, or TopoJSON files on to the map. There is no projection transform support, so this will only work with data in EPSG:4326 and EPSG:3857. Example of using the drag-and-drop interaction. Drag and drop GPX, GeoJSON, IGC, KML, or TopoJSON files on to the map. There is no projection transform support, so this will only work with data in EPSG:4326 and EPSG:3857.
tags: "drag-and-drop, gpx, geojson, igc, kml, topojson" tags: "drag-and-drop, gpx, geojson, igc, kml, topojson"
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>
<div id="info">&nbsp;</div> <div id="info">&nbsp;</div>
+56 -46
View File
@@ -1,71 +1,81 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import {GPX, GeoJSON, IGC, KML, TopoJSON} from '../src/ol/format.js'; goog.require('ol.format.GPX');
import {defaults as defaultInteractions, DragAndDrop} from '../src/ol/interaction.js'; goog.require('ol.format.GeoJSON');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.format.IGC');
import {BingMaps, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.format.KML');
import {Circle as CircleStyle, Fill, Stroke, Style} from '../src/ol/style.js'; goog.require('ol.format.TopoJSON');
goog.require('ol.interaction');
goog.require('ol.interaction.DragAndDrop');
goog.require('ol.layer.Tile');
goog.require('ol.layer.Vector');
goog.require('ol.source.BingMaps');
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');
const defaultStyle = { var defaultStyle = {
'Point': new Style({ 'Point': new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255,255,0,0.5)' color: 'rgba(255,255,0,0.5)'
}), }),
radius: 5, radius: 5,
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#ff0', color: '#ff0',
width: 1 width: 1
}) })
}) })
}), }),
'LineString': new Style({ 'LineString': new ol.style.Style({
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#f00', color: '#f00',
width: 3 width: 3
}) })
}), }),
'Polygon': new Style({ 'Polygon': new ol.style.Style({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(0,255,255,0.5)' color: 'rgba(0,255,255,0.5)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#0ff', color: '#0ff',
width: 1 width: 1
}) })
}), }),
'MultiPoint': new Style({ 'MultiPoint': new ol.style.Style({
image: new CircleStyle({ image: new ol.style.Circle({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255,0,255,0.5)' color: 'rgba(255,0,255,0.5)'
}), }),
radius: 5, radius: 5,
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#f0f', color: '#f0f',
width: 1 width: 1
}) })
}) })
}), }),
'MultiLineString': new Style({ 'MultiLineString': new ol.style.Style({
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#0f0', color: '#0f0',
width: 3 width: 3
}) })
}), }),
'MultiPolygon': new Style({ 'MultiPolygon': new ol.style.Style({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(0,0,255,0.5)' color: 'rgba(0,0,255,0.5)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#00f', color: '#00f',
width: 1 width: 1
}) })
}) })
}; };
const styleFunction = function(feature, resolution) { var styleFunction = function(feature, resolution) {
const featureStyleFunction = feature.getStyleFunction(); var featureStyleFunction = feature.getStyleFunction();
if (featureStyleFunction) { if (featureStyleFunction) {
return featureStyleFunction.call(feature, resolution); return featureStyleFunction.call(feature, resolution);
} else { } else {
@@ -73,52 +83,52 @@ const styleFunction = function(feature, resolution) {
} }
}; };
const dragAndDropInteraction = new DragAndDrop({ var dragAndDropInteraction = new ol.interaction.DragAndDrop({
formatConstructors: [ formatConstructors: [
GPX, ol.format.GPX,
GeoJSON, ol.format.GeoJSON,
IGC, ol.format.IGC,
KML, ol.format.KML,
TopoJSON ol.format.TopoJSON
] ]
}); });
const map = new Map({ var map = new ol.Map({
interactions: defaultInteractions().extend([dragAndDropInteraction]), interactions: ol.interaction.defaults().extend([dragAndDropInteraction]),
layers: [ layers: [
new TileLayer({ new ol.layer.Tile({
source: new BingMaps({ source: new ol.source.BingMaps({
imagerySet: 'Aerial', imagerySet: 'Aerial',
key: 'As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5' key: 'As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5'
}) })
}) })
], ],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
}); });
dragAndDropInteraction.on('addfeatures', function(event) { dragAndDropInteraction.on('addfeatures', function(event) {
const vectorSource = new VectorSource({ var vectorSource = new ol.source.Vector({
features: event.features features: event.features
}); });
map.addLayer(new VectorLayer({ map.addLayer(new ol.layer.Vector({
source: vectorSource, source: vectorSource,
style: styleFunction style: styleFunction
})); }));
map.getView().fit(vectorSource.getExtent()); map.getView().fit(vectorSource.getExtent());
}); });
const displayFeatureInfo = function(pixel) { var displayFeatureInfo = function(pixel) {
const features = []; var features = [];
map.forEachFeatureAtPixel(pixel, function(feature) { map.forEachFeatureAtPixel(pixel, function(feature) {
features.push(feature); features.push(feature);
}); });
if (features.length > 0) { if (features.length > 0) {
const info = []; var info = [];
let i, ii; var i, ii;
for (i = 0, ii = features.length; i < ii; ++i) { for (i = 0, ii = features.length; i < ii; ++i) {
info.push(features[i].get('name')); info.push(features[i].get('name'));
} }
@@ -132,7 +142,7 @@ map.on('pointermove', function(evt) {
if (evt.dragging) { if (evt.dragging) {
return; return;
} }
const pixel = map.getEventPixel(evt.originalEvent); var pixel = map.getEventPixel(evt.originalEvent);
displayFeatureInfo(pixel); displayFeatureInfo(pixel);
}); });
+12 -11
View File
@@ -1,21 +1,22 @@
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 defaultInteractions, DragRotateAndZoom} from '../src/ol/interaction.js'; goog.require('ol.interaction');
import TileLayer from '../src/ol/layer/Tile.js'; goog.require('ol.interaction.DragRotateAndZoom');
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({
interactions: defaultInteractions().extend([ interactions: ol.interaction.defaults().extend([
new DragRotateAndZoom() new ol.interaction.DragRotateAndZoom()
]), ]),
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: [0, 0], center: [0, 0],
zoom: 2 zoom: 2
}) })
+2 -2
View File
@@ -1,9 +1,9 @@
--- ---
layout: example.html layout: example.html
title: Draw and Modify Features title: Draw and Modify Features
shortdesc: Example of using the ol/interaction/Draw interaction together with the ol/interaction/Modify interaction. shortdesc: Example of using the ol.interaction.Draw interaction together with the ol.interaction.Modify interaction.
docs: > docs: >
Example of using the ol/interaction/Draw interaction together with the ol/interaction/Modify interaction. Example of using the ol.interaction.Draw interaction together with the ol.interaction.Modify interaction.
tags: "draw, edit, modify, vector, featureoverlay" tags: "draw, edit, modify, vector, featureoverlay"
--- ---
<div id="map" class="map"></div> <div id="map" class="map"></div>
+29 -22
View File
@@ -1,56 +1,63 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import {Draw, Modify, Snap} from '../src/ol/interaction.js'; goog.require('ol.interaction.Draw');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.interaction.Modify');
import {OSM, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.interaction.Snap');
import {Circle as CircleStyle, Fill, Stroke, Style} from '../src/ol/style.js'; goog.require('ol.layer.Tile');
goog.require('ol.layer.Vector');
goog.require('ol.source.OSM');
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');
const raster = new TileLayer({ var raster = new ol.layer.Tile({
source: new OSM() source: new ol.source.OSM()
}); });
const source = new VectorSource(); var source = new ol.source.Vector();
const vector = new VectorLayer({ var vector = new ol.layer.Vector({
source: source, source: source,
style: new Style({ style: new ol.style.Style({
fill: new Fill({ fill: new ol.style.Fill({
color: 'rgba(255, 255, 255, 0.2)' color: 'rgba(255, 255, 255, 0.2)'
}), }),
stroke: new Stroke({ stroke: new ol.style.Stroke({
color: '#ffcc33', color: '#ffcc33',
width: 2 width: 2
}), }),
image: new CircleStyle({ image: new ol.style.Circle({
radius: 7, radius: 7,
fill: new Fill({ fill: new ol.style.Fill({
color: '#ffcc33' color: '#ffcc33'
}) })
}) })
}) })
}); });
const map = new Map({ var map = new ol.Map({
layers: [raster, vector], layers: [raster, vector],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [-11000000, 4600000], center: [-11000000, 4600000],
zoom: 4 zoom: 4
}) })
}); });
const modify = new Modify({source: source}); var modify = new ol.interaction.Modify({source: source});
map.addInteraction(modify); map.addInteraction(modify);
let draw, snap; // global so we can remove them later var draw, snap; // global so we can remove them later
const typeSelect = document.getElementById('type'); var typeSelect = document.getElementById('type');
function addInteractions() { function addInteractions() {
draw = new Draw({ draw = new ol.interaction.Draw({
source: source, source: source,
type: typeSelect.value type: typeSelect.value
}); });
map.addInteraction(draw); map.addInteraction(draw);
snap = new Snap({source: source}); snap = new ol.interaction.Snap({source: source});
map.addInteraction(snap); map.addInteraction(snap);
} }
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
layout: example.html layout: example.html
title: Draw Features title: Draw Features
shortdesc: Example of using the ol/interaction/Draw interaction. shortdesc: Example of using the ol.interaction.Draw interaction.
docs: > docs: >
Example of using the Draw interaction. Select a geometry type from the Example of using the Draw interaction. Select a geometry type from the
dropdown above to start drawing. To finish drawing, click the last dropdown above to start drawing. To finish drawing, click the last
+17 -15
View File
@@ -1,35 +1,37 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import Draw from '../src/ol/interaction/Draw.js'; goog.require('ol.interaction.Draw');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.layer.Tile');
import {OSM, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.layer.Vector');
goog.require('ol.source.OSM');
goog.require('ol.source.Vector');
const raster = new TileLayer({ var raster = new ol.layer.Tile({
source: new OSM() source: new ol.source.OSM()
}); });
const source = new VectorSource({wrapX: false}); var source = new ol.source.Vector({wrapX: false});
const vector = new VectorLayer({ var vector = new ol.layer.Vector({
source: source source: source
}); });
const map = new Map({ var map = new ol.Map({
layers: [raster, vector], layers: [raster, vector],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [-11000000, 4600000], center: [-11000000, 4600000],
zoom: 4 zoom: 4
}) })
}); });
const typeSelect = document.getElementById('type'); var typeSelect = document.getElementById('type');
let draw; // global so we can remove it later var draw; // global so we can remove it later
function addInteraction() { function addInteraction() {
const value = typeSelect.value; var value = typeSelect.value;
if (value !== 'None') { if (value !== 'None') {
draw = new Draw({ draw = new ol.interaction.Draw({
source: source, source: source,
type: typeSelect.value type: typeSelect.value
}); });
+3 -3
View File
@@ -1,13 +1,13 @@
--- ---
layout: example.html layout: example.html
title: Freehand Drawing title: Freehand Drawing
shortdesc: Example using the ol/interaction/Draw interaction in freehand mode. shortdesc: Example using the ol.interaction.Draw interaction in freehand mode.
docs: > docs: >
This example demonstrates the `ol/interaction/Draw` in freehand mode. During This example demonstrates the `ol.interaction.Draw` in freehand mode. During
freehand drawing, points are added while dragging. Set `freehand: true` to freehand drawing, points are added while dragging. Set `freehand: true` to
enable freehand mode. Note that freehand mode can be conditionally enabled enable freehand mode. Note that freehand mode can be conditionally enabled
by using the `freehandCondition` option. For example to toggle freehand mode by using the `freehandCondition` option. For example to toggle freehand mode
with the `Shift` key, use `freehandCondition: shiftKeyOnly`. with the `Shift` key, use `freehandCondition: ol.events.condition.shiftKeyOnly`.
tags: "draw, edit, freehand, vector" tags: "draw, edit, freehand, vector"
--- ---
<div id="map" class="map"></div> <div id="map" class="map"></div>
+17 -15
View File
@@ -1,35 +1,37 @@
import Map from '../src/ol/Map.js'; goog.require('ol.Map');
import View from '../src/ol/View.js'; goog.require('ol.View');
import Draw from '../src/ol/interaction/Draw.js'; goog.require('ol.interaction.Draw');
import {Tile as TileLayer, Vector as VectorLayer} from '../src/ol/layer.js'; goog.require('ol.layer.Tile');
import {OSM, Vector as VectorSource} from '../src/ol/source.js'; goog.require('ol.layer.Vector');
goog.require('ol.source.OSM');
goog.require('ol.source.Vector');
const raster = new TileLayer({ var raster = new ol.layer.Tile({
source: new OSM() source: new ol.source.OSM()
}); });
const source = new VectorSource({wrapX: false}); var source = new ol.source.Vector({wrapX: false});
const vector = new VectorLayer({ var vector = new ol.layer.Vector({
source: source source: source
}); });
const map = new Map({ var map = new ol.Map({
layers: [raster, vector], layers: [raster, vector],
target: 'map', target: 'map',
view: new View({ view: new ol.View({
center: [-11000000, 4600000], center: [-11000000, 4600000],
zoom: 4 zoom: 4
}) })
}); });
const typeSelect = document.getElementById('type'); var typeSelect = document.getElementById('type');
let draw; // global so we can remove it later var draw; // global so we can remove it later
function addInteraction() { function addInteraction() {
const value = typeSelect.value; var value = typeSelect.value;
if (value !== 'None') { if (value !== 'None') {
draw = new Draw({ draw = new ol.interaction.Draw({
source: source, source: source,
type: typeSelect.value, type: typeSelect.value,
freehand: true freehand: true

Some files were not shown because too many files have changed in this diff Show More