Better document which events are fired
The map does not fire ol.render.Event#render. Change events are now only listed for classes that fire them, and a description about when they are fired is added.
This commit is contained in:
@@ -68,6 +68,7 @@ ol.DeviceOrientationProperty = {
|
|||||||
*
|
*
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
|
* @fires change Triggered when the device orientation changes.
|
||||||
* @param {olx.DeviceOrientationOptions=} opt_options Options.
|
* @param {olx.DeviceOrientationOptions=} opt_options Options.
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ goog.require('ol.style.Style');
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
|
* @fires change Triggered when the geometry or style of the feature changes.
|
||||||
* @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrValues
|
* @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrValues
|
||||||
* Values or geometry.
|
* Values or geometry.
|
||||||
* @todo api
|
* @todo api
|
||||||
|
|||||||
@@ -51,6 +51,7 @@ ol.GeolocationProperty = {
|
|||||||
*
|
*
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
|
* @fires change Triggered when the position changes.
|
||||||
* @param {olx.GeolocationOptions=} opt_options Options.
|
* @param {olx.GeolocationOptions=} opt_options Options.
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -46,6 +46,7 @@ ol.geom.GeometryLayout = {
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Observable}
|
* @extends {ol.Observable}
|
||||||
|
* @fires change Triggered when the geometry changes.
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
ol.geom.Geometry = function() {
|
ol.geom.Geometry = function() {
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ goog.require('ol.source.Source');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Base}
|
* @extends {ol.layer.Base}
|
||||||
* @fires ol.render.Event
|
* @fires ol.render.Event
|
||||||
|
* @fires change Triggered when the state of the source changes.
|
||||||
* @param {olx.layer.LayerOptions} options Layer options.
|
* @param {olx.layer.LayerOptions} options Layer options.
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -27,6 +27,8 @@ ol.layer.GroupProperty = {
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Base}
|
* @extends {ol.layer.Base}
|
||||||
|
* @fires change Triggered when the state of the source of any of the layers of
|
||||||
|
* this group changes
|
||||||
* @param {olx.layer.GroupOptions=} opt_options Layer options.
|
* @param {olx.layer.GroupOptions=} opt_options Layer options.
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -158,7 +158,8 @@ ol.MapProperty = {
|
|||||||
* @param {olx.MapOptions} options Map options.
|
* @param {olx.MapOptions} options Map options.
|
||||||
* @fires ol.MapBrowserEvent
|
* @fires ol.MapBrowserEvent
|
||||||
* @fires ol.MapEvent
|
* @fires ol.MapEvent
|
||||||
* @fires ol.render.Event
|
* @fires ol.render.Event#postcompose
|
||||||
|
* @fires ol.render.Event#precompose
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
ol.Map = function(options) {
|
ol.Map = function(options) {
|
||||||
|
|||||||
@@ -31,8 +31,7 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Dispatches a `change` event. Register a listener for this event to get
|
* Dispatches a `change` event.
|
||||||
* notified of changes.
|
|
||||||
* @fires change
|
* @fires change
|
||||||
* @todo api
|
* @todo api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -35,6 +35,7 @@ ol.source.SourceOptions;
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Observable}
|
* @extends {ol.Observable}
|
||||||
|
* @fires change Triggered when the state of the source changes.
|
||||||
* @param {ol.source.SourceOptions} options Source options.
|
* @param {ol.source.SourceOptions} options Source options.
|
||||||
*/
|
*/
|
||||||
ol.source.Source = function(options) {
|
ol.source.Source = function(options) {
|
||||||
|
|||||||
Reference in New Issue
Block a user