JSDoc: o-viewport

setThrottleInterval(eventType, interval)

Global Function

Returns

• void

Example

// throttle for different events at different durations
    setThrottleInterval('scroll', 100)
    setThrottleInterval('resize', 300)
    setThrottleInterval('orientation', 30)
    setThrottleInterval('visibility', 30)
		// throttle all events at 30ms
    setThrottleInterval(30);

Links

• "setThrottleInterval" function on Github

listenTo(eventType)

Global Function

Start listening for an event(s).

Example

// Start listening for all events.
		oViewport.listenTo('all');

		// It is now possible to listen for debounce o-viewport events such as `oViewport.orientation`.
     document.body.addEventListener('oViewport.orientation', function(event) {
     	console.log(event.type); // oViewport.orientation
     });

Links

• "listenTo" function on Github

stopListeningTo(eventType)

Global Function

Stop listening for an event(s).

Example

// Start listening for all events.
		oViewport.listenTo('all');
		// We're done. Stop listening for all events.
		oViewport.stopListeningTo('all');

Links

• "stopListeningTo" function on Github

broadcast(...)

Global Function

Links

• "broadcast" function on Github

getHeight(ignoreScrollbars)

Global Function

Get the viewport height.

Returns

• number

Links

• "getHeight" function on Github

getWidth(ignoreScrollbars)

Global Function

Get the viewport width.

Returns

• number

Links

• "getWidth" function on Github

getSize(ignoreScrollbars)

Global Function

Get the viewport width and height.

Returns

• Size

Links

• "getSize" function on Github

getScrollPosition

Global Function

Returns

• ScrollPosition

Links

• "getScrollPosition" function on Github

getOrientation

Global Function

Returns

• string - - 'portrait' or 'landscape'

Links

• "getOrientation" function on Github

getVisibility

Global Function

Returns

• boolean - - true if the viewport is visible

Links

• "getVisibility" function on Github

Size

Viewport size.

Properties

• height - (type: number)
• width - (type: number)

Type

Object

Links

• "Size" typedef on Github

ScrollPosition

Scroll position.

Properties

• height - (type: number) `document.body.scrollHeight`
• width - (type: number) `document.body.scrollWidth`
• left - (type: number) `window.pageXOffset || window.scrollX`
• top - (type: number) `window.pageYOffset || window.scrollY`

Type

Object

Links

• "ScrollPosition" typedef on Github