Openlayers: How do I navigate the new API docs?

Created on 15 Oct 2018  路  4Comments  路  Source: openlayers/openlayers

I'm having a very hard time navigating to the basics in the API docs now that it's changed since I last used OpenLayers a year ago. I mainly struggle to find class instance methods.

For example, I want to figure out how to properly disconnect my Map object's event handlers but I can't find documentation for any methods.

Am I missing something obvious or has discoverability taken a bit of a dive?

Thank you.

Most helpful comment

We're still in the process of making the API docs work better with the new TypeScript types. Please be patient. The next release should have better docs again.

All 4 comments

true, it gets very hard to find methods.

We're still in the process of making the API docs work better with the new TypeScript types. Please be patient. The next release should have better docs again.

At the moment, I use mostly OpenLayers v4.6.5 apidoc http://openlayers.org/en/v4.6.5/apidoc/ to quickly find out my way in class inheritances, methods and properties. This version of API docs misses some latest methods or options but as they mostly did not change, it's enough to wait for the doc improvements. The only annoying drawback from my viewpoint I have to deal with is the difference between:

import Map from 'ol/Map'; // v 5.x
import Map from 'ol/map'; // v4.6.5

I never remember the convention change between both

@ahocevar if it's a transient issue then that's completely understandable. Thank you.

@ThomasG77 I had no idea how to get to the old docs. That helps a lot. Thanks!

Was this page helpful?
0 / 5 - 0 ratings