{ "project": { "name": "jquery.nanoscroller", "description": "A jQuery plugin that offers a simplistic way of implementing Lion OS scrollbars.", "version": "0.8.7", "url": "http://jamesflorentino.github.com/nanoScrollerJS/" }, "files": { "bin/javascripts/jquery.nanoscroller.js": { "name": "bin/javascripts/jquery.nanoscroller.js", "modules": {}, "classes": { "NanoScroll": 1 }, "fors": {}, "namespaces": {} } }, "modules": {}, "classes": { "NanoScroll": { "name": "NanoScroll", "shortname": "NanoScroll", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "file": "bin/javascripts/jquery.nanoscroller.js", "line": 354, "params": [ { "name": "element", "description": "the main element", "type": "HTMLElement|Node" }, { "name": "options", "description": "nanoScroller's options", "type": "Object" } ], "is_constructor": 1 } }, "classitems": [ { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 19, "description": "a classname for the pane element.", "itemtype": "property", "name": "paneClass", "type": "String", "default": "'nano-pane'", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 27, "description": "a classname for the slider element.", "itemtype": "property", "name": "sliderClass", "type": "String", "default": "'nano-slider'", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 35, "description": "a classname for the content element.", "itemtype": "property", "name": "contentClass", "type": "String", "default": "'nano-content'", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 43, "description": "a setting to enable native scrolling in iOS devices.", "itemtype": "property", "name": "iOSNativeScrolling", "type": "Boolean", "default": "false", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 51, "description": "a setting to prevent the rest of the page being\nscrolled when user scrolls the `.content` element.", "itemtype": "property", "name": "preventPageScrolling", "type": "Boolean", "default": "false", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 60, "description": "a setting to disable binding to the resize event.", "itemtype": "property", "name": "disableResize", "type": "Boolean", "default": "false", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 68, "description": "a setting to make the scrollbar always visible.", "itemtype": "property", "name": "alwaysVisible", "type": "Boolean", "default": "false", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 76, "description": "a default timeout for the `flash()` method.", "itemtype": "property", "name": "flashDelay", "type": "Number", "default": "1500", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 84, "description": "a minimum height for the `.slider` element.", "itemtype": "property", "name": "sliderMinHeight", "type": "Number", "default": "20", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 92, "description": "a maximum height for the `.slider` element.", "itemtype": "property", "name": "sliderMaxHeight", "type": "Number", "default": "null", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 100, "description": "an alternate document context.", "itemtype": "property", "name": "documentContext", "type": "Document", "default": "null", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 108, "description": "an alternate window context.", "itemtype": "property", "name": "windowContext", "type": "Window", "default": "null", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 117, "itemtype": "property", "name": "SCROLLBAR", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 126, "itemtype": "property", "name": "SCROLL", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 135, "itemtype": "property", "name": "MOUSEDOWN", "type": "String", "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 143, "itemtype": "property", "name": "MOUSEENTER", "type": "String", "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 151, "itemtype": "property", "name": "MOUSEMOVE", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 160, "itemtype": "property", "name": "MOUSEWHEEL", "type": "String", "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 168, "itemtype": "property", "name": "MOUSEUP", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 177, "itemtype": "property", "name": "RESIZE", "type": "String", "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 185, "itemtype": "property", "name": "DRAG", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 194, "itemtype": "property", "name": "ENTER", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 203, "itemtype": "property", "name": "UP", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 212, "itemtype": "property", "name": "PANEDOWN", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 221, "itemtype": "property", "name": "DOMSCROLL", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 230, "itemtype": "property", "name": "DOWN", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 239, "itemtype": "property", "name": "WHEEL", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 248, "itemtype": "property", "name": "KEYDOWN", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 257, "itemtype": "property", "name": "KEYUP", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 266, "itemtype": "property", "name": "TOUCHMOVE", "type": "String", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 275, "itemtype": "property", "name": "BROWSER_IS_IE7", "type": "Boolean", "static": 1, "final": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 284, "itemtype": "property", "name": "BROWSER_SCROLLBAR_WIDTH", "type": "Number", "static": 1, "default": "null", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 319, "description": "Returns browser's native scrollbar width", "itemtype": "method", "name": "getBrowserScrollbarWidth", "return": { "description": "the scrollbar width in pixels", "type": "Number" }, "static": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 384, "description": "Prevents the rest of the page being scrolled\nwhen user scrolls the `.nano-content` element.", "itemtype": "method", "name": "preventScrolling", "params": [ { "name": "event", "description": "", "type": "Event" }, { "name": "direction", "description": "Scroll direction (up or down)", "type": "String" } ], "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 412, "description": "Enable iOS native scrolling", "itemtype": "method", "name": "nativeScrolling", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 427, "description": "Updates those nanoScroller properties that\nare related to current scrollbar position.", "itemtype": "method", "name": "updateScrollValues", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 456, "description": "Updates CSS styles for current scroll position.\nUses CSS 2d transfroms and `window.requestAnimationFrame` if available.", "itemtype": "method", "name": "setOnScrollStyles", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 489, "description": "Creates event related methods", "itemtype": "method", "name": "createEvents", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 603, "description": "Adds event listeners with jQuery.", "itemtype": "method", "name": "addEvents", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 624, "description": "Removes event listeners with jQuery.", "itemtype": "method", "name": "removeEvents", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 642, "description": "Generates nanoScroller's scrollbar and elements for it.", "itemtype": "method", "name": "generate", "chainable": 1, "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 677, "itemtype": "method", "name": "restore", "access": "private", "tagname": "", "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 691, "description": "Resets nanoScroller's scrollbar.", "itemtype": "method", "name": "reset", "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller();" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 774, "itemtype": "method", "name": "scroll", "access": "private", "tagname": "", "example": [ "\n $(\".nano\").nanoScroller({ scroll: 'top' });" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 796, "description": "Scroll at the bottom with an offset value", "itemtype": "method", "name": "scrollBottom", "params": [ { "name": "offsetY", "description": "", "type": "Number" } ], "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller({ scrollBottom: value });" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 815, "description": "Scroll at the top with an offset value", "itemtype": "method", "name": "scrollTop", "params": [ { "name": "offsetY", "description": "", "type": "Number" } ], "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller({ scrollTop: value });" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 834, "description": "Scroll to an element", "itemtype": "method", "name": "scrollTo", "params": [ { "name": "node", "description": "A node to scroll to.", "type": "Node" } ], "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller({ scrollTo: $('#a_node') });" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 852, "description": "To stop the operation.\nThis option will tell the plugin to disable all event bindings and hide the gadget scrollbar from the UI.", "itemtype": "method", "name": "stop", "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller({ stop: true });" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 875, "description": "Destroys nanoScroller and restores browser's native scrollbar.", "itemtype": "method", "name": "destroy", "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller({ destroy: true });" ], "class": "NanoScroll" }, { "file": "bin/javascripts/jquery.nanoscroller.js", "line": 904, "description": "To flash the scrollbar gadget for an amount of time defined in plugin settings (defaults to 1,5s).\nUseful if you want to show the user (e.g. on pageload) that there is more content waiting for him.", "itemtype": "method", "name": "flash", "chainable": 1, "example": [ "\n $(\".nano\").nanoScroller({ flash: true });" ], "class": "NanoScroll" } ], "warnings": [] }