Chico UI

ch.Viewport (Class)

Documentation updated on Fri May 18 2012 12:47:11 GMT-0300 (GMT-03:00), generated by JsDoc Toolkit 2.4.0

Contents
1 Overview
2 Summary
3 Classdetail
4 Properties detail
5 Methods detail

Overview

Viewport is a reference to position and size of the visible area of browser.

Summary

Visibility Name Description
<public>  
bottom
Bottom offset of the visible area.
<public>  
element
Element representing the visible area.
<public>  
height
Height of the visible area.
<public>  
left
Left offset of the visible area.
<public>  
right
Right offset of the visible area.
<public>  
top
Top offset of the visible area.
<public>  
width
Width of the visible area.
Visibility Name Description
<public>  
getOffset()
Updates left, top, right and bottom coordinates of the visible area, relative to the document.
<public>  
getPosition()
Updates left, top, right and bottom coordinates of the visible area, relative to the window.
<public>  
getSize()
Updates width and height of the visible area and updates ch.viewport.width and ch.viewport.height

Classdetail

Properties detail

bottom (public, Number)

Bottom offset of the visible area.

element (public, Object)

Element representing the visible area.

height (public, Number)

Height of the visible area.

left (public, Number)

Left offset of the visible area.

Right offset of the visible area.

top (public, Number)

Top offset of the visible area.

width (public, Number)

Width of the visible area.

Methods detail

getOffset (public)

Updates left, top, right and bottom coordinates of the visible area, relative to the document.

Returns
  • Object

getPosition (public)

Updates left, top, right and bottom coordinates of the visible area, relative to the window.

Returns
  • Object

getSize (public)

Updates width and height of the visible area and updates ch.viewport.width and ch.viewport.height

Returns
  • Object