From 3c177564f6b97034ff248b955b421fa9eee0d373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20S=C3=A1nchez=20Ortega?= Date: Wed, 10 Jun 2015 12:43:56 +0200 Subject: [PATCH] Bits of documentation for L.DomEvent and L.DomUtil (see #3098) --- reference.html | 72 ++++++++++++++++++++++++++++++++++---------------- 1 file changed, 49 insertions(+), 23 deletions(-) diff --git a/reference.html b/reference.html index 57eac7c5..ee394994 100644 --- a/reference.html +++ b/reference.html @@ -5224,25 +5224,46 @@ Popups will also be automatically opened when the layer is clicked on and closed Description - addListener( + on( <HTMLElement> el, - <String> type, + <String> types, <Function> fn, <Object> context? ) this - Adds a listener fn to the element's DOM event of the specified type. this keyword inside the listener will point to context, or to the element if not specified. + Adds a listener fn to the element's DOM events. types is a space-separated list of DOM event types to listen to. this keyword inside the listener will point to context, or to the element if not specified. - removeListener( + addListener( <HTMLElement> el, - <String> type, + <String> types, + <Function> fn, + <Object> context? ) + + + this + Alias for DomEvent.on. + + + off( + <HTMLElement> el, + <String> types, <Function> fn ) this - Removes an event listener from the element. + Removes the event listener fn from the element, for the DOM event types in types (a space-separated list). fn must be equal to the function currently listening to the event for it to be removed. + + + removeListener( + <HTMLElement> el, + <String> types, + <Function> fn ) + + + this + Alias for DomEvent.off. stopPropagation( @@ -5344,6 +5365,20 @@ Popups will also be automatically opened when the layer is clicked on and closed Creates an element with tagName, sets the className, and optionally appends it to container element. + + remove( + <HTMLElement> el ) + + - + Removes el from its parent element. + + + empty( + <HTMLElement> el ) + + - + Removes all of el's children elements from el. + disableTextSelection() - @@ -5425,31 +5460,22 @@ Popups will also be automatically opened when the layer is clicked on and closed Goes through the array of style names and returns the first name that is a valid style name for an element. If no such name is found, it returns false. Useful for vendor-prefixed styles like transform. - getTranslateString( - <Point> point ) + setTransform( + <HTMLElement> el, + <Point> offset, + <Number> scale? ) - - String - Returns a CSS transform string to move an element by the offset provided in the given point. Uses 3D translate on WebKit for hardware-accelerated transforms and 2D on other browsers. - - - getScaleString( - <Number> scale, - <Point> origin ) - - - String - Returns a CSS transform string to scale an element (with the given scale origin). + - + Resets the 3D CSS transform of el so it is translated by offset and optionally scaled by scale. Does not have an effect if the browser doesn't support 3D CSS transforms. setPosition( <HTMLElement> el, - <Point> point, - <Boolean> disable3D? ) + <Point> point ) - - Sets the position of an element to coordinates specified by point, using CSS translate or top/left positioning depending on the browser (used by Leaflet internally to position its layers). Forces top/left positioning if disable3D is true. + Sets the position of an element to coordinates specified by point, using CSS translate or top/left positioning depending on the browser (used by Leaflet internally to position its layers). getPosition(