Ext.data.JsonP.Backbone_PageableCollection({ "tagname": "class", "name": "Backbone.PageableCollection", "extends": "Backbone.Collection", "mixins": [ ], "alternateClassNames": [ ], "aliases": { }, "singleton": false, "requires": [ ], "uses": [ ], "enum": null, "override": null, "inheritable": null, "inheritdoc": null, "meta": { }, "private": null, "id": "class-Backbone.PageableCollection", "members": { "cfg": [ ], "property": [ { "name": "fullCollection", "tagname": "property", "owner": "Backbone.PageableCollection", "meta": { }, "id": "property-fullCollection" }, { "name": "mode", "tagname": "property", "owner": "Backbone.PageableCollection", "meta": { }, "id": "property-mode" }, { "name": "queryParams", "tagname": "property", "owner": "Backbone.PageableCollection", "meta": { }, "id": "property-queryParams" }, { "name": "state", "tagname": "property", "owner": "Backbone.PageableCollection", "meta": { }, "id": "property-state" } ], "method": [ { "name": "constructor", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-constructor" }, { "name": "_checkState", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "private": true }, "id": "method-_checkState" }, { "name": "_makeCollectionEventHandler", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "private": true }, "id": "method-_makeCollectionEventHandler" }, { "name": "_makeComparator", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "protected": true }, "id": "method-_makeComparator" }, { "name": "_makeFullCollection", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "private": true }, "id": "method-_makeFullCollection" }, { "name": "fetch", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-fetch" }, { "name": "getFirstPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-getFirstPage" }, { "name": "getLastPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-getLastPage" }, { "name": "getNextPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-getNextPage" }, { "name": "getPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-getPage" }, { "name": "getPageByOffset", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-getPageByOffset" }, { "name": "getPreviousPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-getPreviousPage" }, { "name": "hasNext", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-hasNext" }, { "name": "hasNextPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-hasNextPage" }, { "name": "hasPrevious", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-hasPrevious" }, { "name": "hasPreviousPage", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-hasPreviousPage" }, { "name": "parse", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-parse" }, { "name": "parseLinks", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-parseLinks" }, { "name": "parseRecords", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-parseRecords" }, { "name": "parseState", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-parseState" }, { "name": "setPageSize", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-setPageSize" }, { "name": "setSorting", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-setSorting" }, { "name": "switchMode", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "chainable": true }, "id": "method-switchMode" }, { "name": "sync", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { }, "id": "method-sync" } ], "event": [ ], "css_var": [ ], "css_mixin": [ ] }, "linenr": 120, "files": [ { "filename": "backbone-pageable.js", "href": null } ], "html_meta": { }, "statics": { "cfg": [ ], "property": [ ], "method": [ { "name": "noConflict", "tagname": "method", "owner": "Backbone.PageableCollection", "meta": { "static": true }, "id": "static-method-noConflict" } ], "event": [ ], "css_var": [ ], "css_mixin": [ ] }, "component": false, "superclasses": [ "Backbone.Collection" ], "subclasses": [ ], "mixedInto": [ ], "parentMixins": [ ], "html": "
Hierarchy
Backbone.Collection
Backbone.PageableCollection

Drop-in replacement for Backbone.Collection. Supports server-side and\nclient-side pagination and sorting. Client-side mode also support fully\nmulti-directional synchronization of changes between pages.

\n
Defined By

Properties

Backbone.PageableCollection
: Backbone.Collection
CLIENT MODE ONLY\n\nThis collection is the internal storage for the bootstrapped or fetched\nmodels. ...

CLIENT MODE ONLY

\n\n

This collection is the internal storage for the bootstrapped or fetched\nmodels. You can use this if you want to operate on all the pages.

\n
Backbone.PageableCollection
: \"server\"|\"client\"|\"infinite\"
The mode of\noperations for this collection. ...

The mode of\noperations for this collection. \"server\" paginates on the server-side,\n\"client\" paginates on the client-side and \"infinite\" paginates on the\nserver-side for APIs that do not support totalRecords.

\n

Defaults to: "server"

Backbone.PageableCollection
: Object
A translation map to convert Backbone.PageableCollection state attributes\nto the query parameters accepted by your se...

A translation map to convert Backbone.PageableCollection state attributes\nto the query parameters accepted by your server API.

\n\n

You can override the default state by extending this class or specifying\nthem in options.queryParams object hash to the constructor.

\n

Defaults to: {currentPage: "page", pageSize: "per_page", totalPages: "total_pages", totalRecords: "total_entries", sortKey: "sort_by", order: "order", directions: {"-1": "asc", "1": "desc"}}

  • currentPage : string (optional)

    Defaults to: "page"

  • pageSize : string (optional)

    Defaults to: "per_page"

  • totalPages : string (optional)

    Defaults to: "total_pages"

  • totalRecords : string (optional)

    Defaults to: "total_entries"

  • sortKey : string (optional)

    Defaults to: "sort_by"

  • order : string (optional)

    Defaults to: "order"

  • directions : string (optional)

    A\nmap for translating a Backbone.PageableCollection.state.order constant to\nthe ones your server API accepts.

    \n

    Defaults to: {"-1": "asc", "1": "desc"}

Backbone.PageableCollection
: Object
The container object to store all pagination states. ...

The container object to store all pagination states.

\n\n

You can override the default state by extending this class or specifying\nthem in an options hash to the constructor.

\n
  • firstPage : 0|1 (optional)

    The first page index. Set to 0 if\nyour server API uses 0-based indices. You should only override this value\nduring extension, initialization or reset by the server after\nfetching. This value should be read only at other times.

    \n

    Defaults to: 1

  • lastPage : number (optional)

    The last page index. This value\nis read only and it's calculated based on whether firstPage is 0 or\n1, during bootstrapping, fetching and resetting. Please don't change this\nvalue under any circumstances.

    \n

    Defaults to: null

  • currentPage : number (optional)

    The current page index. You\nshould only override this value during extension, initialization or reset\nby the server after fetching. This value should be read only at other\ntimes. Can be a 0-based or 1-based index, depending on whether\nfirstPage is 0 or 1. If left as default, it will be set to firstPage\non initialization.

    \n

    Defaults to: null

  • pageSize : number (optional)

    How many records to show per\npage. This value is read only after initialization, if you want to\nchange the page size after initialization, you must call setPageSize.

    \n

    Defaults to: 25

  • totalPages : number (optional)

    How many pages there are. This\nvalue is read only and it is calculated from totalRecords.

    \n

    Defaults to: null

  • totalRecords : number (optional)

    How many records there\nare. This value is required under server mode. This value is optional\nfor client mode as the number will be the same as the number of models\nduring bootstrapping and during fetching, either supplied by the server\nin the metadata, or calculated from the size of the response.

    \n

    Defaults to: null

  • sortKey : string (optional)

    The model attribute to use for\nsorting.

    \n

    Defaults to: null

  • order : -1|0|1 (optional)

    The order to use for sorting. Specify\n-1 for ascending order or 1 for descending order. If 0, no client side\nsorting will be done and the order query parameter will not be sent to\nthe server during a fetch.

    \n

    Defaults to: -1

Methods

Defined By

Instance Methods

Backbone.PageableCollection
new( [models], [options] ) : Backbone.PageableCollection
Given a list of models or model attributues, bootstraps the full\ncollection in client mode or infinite mode, or just ...

Given a list of models or model attributues, bootstraps the full\ncollection in client mode or infinite mode, or just the page you want in\nserver mode.

\n\n

If you want to initialize a collection to a different state than the\ndefault, you can specify them in options.state. Any state parameters\nsupplied will be merged with the default. If you want to change the\ndefault mapping from state keys to your server API's query parameter\nnames, you can specifiy an object hash in option.queryParams. Likewise,\nany mapping provided will be merged with the default. Lastly, all\nBackbone.Collection constructor options are also accepted.

\n\n

See:

\n\n\n\n

Parameters

  • models : Array.<Object> (optional)
    \n
  • options : Object (optional)
    \n
    • comparator : function(*, *): number (optional)

      If specified, this\ncomparator is set to the current page under server mode, or the fullCollection\notherwise.

      \n
    • full : boolean (optional)

      If false and either a\noptions.comparator or sortKey is defined, the comparator is attached\nto the current page. Default is true under client or infinite mode and\nthe comparator will be attached to the fullCollection.

      \n
    • state : Object (optional)

      The state attributes overriding the defaults.

      \n
      • sortKey : string (optional)

        The model attribute to use for\nsorting. If specified instead of options.comparator, a comparator will\nbe automatically created using this value, and optionally a sorting order\nspecified in options.state.order. The comparator is then attached to\nthe new collection instance.

        \n
      • order : -1|1 (optional)

        The order to use for sorting. Specify\n-1 for ascending order and 1 for descending order.

        \n
    • queryParam : Object (optional)

Returns

Backbone.PageableCollection
( state ) : Objectprivate
Sanity check this collection's pagination states. ...

Sanity check this collection's pagination states. Only perform checks\nwhen all the required pagination state values are defined and not null.\nIf totalPages is undefined or null, it is set to totalRecords /\npageSize. lastPage is set according to whether firstPage is 0 or 1\nwhen no error occurs.

\n

Parameters

  • state : Object
    \n

Returns

  • Object

    Returns the state object if no error was found.

    \n

Throws

  • TypeError

    If totalRecords, pageSize, currentPage or\nfirstPage is not a finite integer.

    \n
  • RangeError

    If pageSize, currentPage or firstPage is out\nof bounds.

    \n
Backbone.PageableCollection
( pageCol, fullCol ) : function(string, Backbone.Model, Backbone.Collection, Object)private
Factory method that returns a Backbone event handler that responses to\nthe add, remove, reset, and the sort events. ...

Factory method that returns a Backbone event handler that responses to\nthe add, remove, reset, and the sort events. The returned event\nhandler will synchronize the current page collection and the full\ncollection's models.

\n

Parameters

Returns

  • function(string, Backbone.Model, Backbone.Collection, Object)

    Collection event handler

    \n
Backbone.PageableCollection
( [sortKey], [order], [sortValue] )protected
Convenient method for making a comparator sorted by a model attribute\nidentified by sortKey and ordered by order. ...

Convenient method for making a comparator sorted by a model attribute\nidentified by sortKey and ordered by order.

\n\n

Like a Backbone.Collection, a Backbone.PageableCollection will maintain\nthe current page in sorted order on the client side if a comparator\nis attached to it. If the collection is in client mode, you can attach a\ncomparator to fullCollection to have all the pages reflect the global\nsorting order by specifying an option full to true. You must call\nsort manually or fullCollection.sort after calling this method to\nforce a resort.

\n\n

While you can use this method to sort the current page in server mode,\nthe sorting order may not reflect the global sorting order due to the\nadditions or removals of the records on the server since the last\nfetch. If you want the most updated page in a global sorting order, it is\nrecommended that you set state.sortKey and optionally state.order, and\nthen call fetch.

\n

Parameters

  • sortKey : string (optional)

    See state.sortKey.

    \n

    Defaults to: this.state.sortKey

  • order : number (optional)

    See state.order.

    \n

    Defaults to: this.state.order

  • sortValue : (function(Backbone.Model, string): Object) | string (optional)

    See setSorting.

    \n\n

    See Backbone.Collection.comparator.

    \n
Backbone.PageableCollection
( models, options ) : Backbone.Collectionprivate
Makes a Backbone.Collection that contains all the pages. ...

Makes a Backbone.Collection that contains all the pages.

\n

Parameters

  • models : Array.<Object|Backbone.Model>
    \n
  • options : Object

    Options for Backbone.Collection constructor.

    \n

Returns

  • Backbone.Collection
    \n
Backbone.PageableCollection
( [options] ) : XMLHttpRequest
Fetch a page from the server in server mode, or all the pages in client\nmode. ...

Fetch a page from the server in server mode, or all the pages in client\nmode. Under infinite mode, the current page is refetched by default and\nthen reset.

\n\n

The query string is constructed by translating the current pagination\nstate to your server API query parameter using queryParams. The current\npage will reset after fetch.

\n

Parameters

Returns

  • XMLHttpRequest
    \n
Backbone.PageableCollection
( options ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Fetch the first page in server mode, or reset the current page of this\ncollection to the first page in client or infi...

Fetch the first page in server mode, or reset the current page of this\ncollection to the first page in client or infinite mode.

\n

Parameters

Returns

Backbone.PageableCollection
( options ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Fetch the last page in server mode, or reset the current page of this\ncollection to the last page in client mode. ...

Fetch the last page in server mode, or reset the current page of this\ncollection to the last page in client mode.

\n

Parameters

Returns

Backbone.PageableCollection
( options ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Fetch the next page in server mode, or reset the current page of this\ncollection to the next page in client mode. ...

Fetch the next page in server mode, or reset the current page of this\ncollection to the next page in client mode.

\n

Parameters

Returns

Backbone.PageableCollection
( index, [options] ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Given a page index, set state.currentPage to that index. ...

Given a page index, set state.currentPage to that index. If this\ncollection is in server mode, fetch the page using the updated state,\notherwise, reset the current page of this collection to the page\nspecified by index in client mode. If options.fetch is true, a fetch\ncan be forced in client mode before resetting the current page. Under\ninfinite mode, if the index is less than the current page, a reset is\ndone as in client mode. If the index is greater than the current page\nnumber, a fetch is made with the results appended to fullCollection.\nThe current page will then be reset after fetching.

\n

Parameters

  • index : number|string

    The page index to go to, or the page name to\nlook up from #links in infinite mode.

    \n
  • options : Object (optional)

    fetch options or\nreset options for client mode\nwhen options.fetch is false.

    \n
    • fetch : boolean (optional)

      If true, force a fetch in\nclient mode.

      \n

      Defaults to: false

Returns

Throws

  • TypeError

    If index is not a finite integer under server or\nclient mode, or does not yield a URL from #links under infinite mode.

    \n
  • RangeError

    If index is out of bounds.

    \n
Backbone.PageableCollection
( options ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Fetch the page for the provided item offset in server mode, or reset the current page of this\ncollection to the page ...

Fetch the page for the provided item offset in server mode, or reset the current page of this\ncollection to the page for the provided item offset in client mode.

\n

Parameters

Returns

Backbone.PageableCollection
( options ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Fetch the previous page in server mode, or reset the current page of this\ncollection to the previous page in client o...

Fetch the previous page in server mode, or reset the current page of this\ncollection to the previous page in client or infinite mode.

\n

Parameters

Returns

Backbone.PageableCollection
( )
Delegates to hasNextPage. ...

Delegates to hasNextPage.

\n
Backbone.PageableCollection
( ) : boolean
...
\n

Returns

  • boolean

    true if this collection can page forward, false\notherwise.

    \n
Backbone.PageableCollection
( )
Delegates to hasPreviousPage. ...

Delegates to hasPreviousPage.

\n
Backbone.PageableCollection
( ) : boolean
...
\n

Returns

  • boolean

    true if this collection can page backward, false\notherwise.

    \n
Backbone.PageableCollection
( resp, options )
Parse server response data. ...

Parse server response data.

\n\n

This default implementation assumes the response data is in one of two\nstructures:

\n\n
[\n  {}, // Your new pagination state\n  [{}, ...] // An array of JSON objects\n]\n
\n\n

Or,

\n\n
[{}] // An array of JSON objects\n
\n\n

The first structure is the preferred form because the pagination states\nmay have been updated on the server side, sending them down again allows\nthis collection to update its states. If the response has a pagination\nstate object, it is checked for errors.

\n\n

The second structure is the\nBackbone.Collection#parse\ndefault.

\n\n

*Note:** this method has been further simplified since 1.1.7. While\n existing parse implementations will continue to work, new code is\n encouraged to override parseState and parseRecords instead.

\n\n
   @param {Object} resp The deserialized response data from the server.\n   @param {Object} the options for the ajax request\n\n   @return {Array.<Object>} An array of model objects\n
\n

Parameters

  • resp : Object
    \n
  • options : Object
    \n
Backbone.PageableCollection
( resp, [options] ) : Object
Parse pagination links from the server response. ...

Parse pagination links from the server response. Only valid under\ninfinite mode.

\n\n

Given a response body and a XMLHttpRequest object, extract pagination\nlinks from them for infinite paging.

\n\n

This default implementation parses the RFC 5988 Link header and extract\n3 links from it - first, prev, next. Any subclasses overriding this\nmethod must return an object hash having only the keys\nabove. However, simply returning a next link or an empty hash if there\nare no more links should be enough for most implementations.

\n

Parameters

  • resp : *

    The deserialized response body.

    \n
  • options : Object (optional)
    \n
    • xhr : XMLHttpRequest (optional)

      The XMLHttpRequest object for this\nresponse.

      \n

Returns

  • Object
    \n
Backbone.PageableCollection
( resp, [options] ) : Array.<Object>
Parse server response for an array of model objects. ...

Parse server response for an array of model objects.

\n\n

This default implementation first checks whether the response has any\nstate object as documented in parse. If it exists, the array of model\nobjects is assumed to be the second element, otherwise the entire\nresponse is returned directly.

\n

Parameters

  • resp : Object

    The deserialized response data from the server.

    \n
  • options : Object (optional)

    The options passed through from the\nparse. (backbone >= 0.9.10 only)

    \n

Returns

  • Array.<Object>

    An array of model objects

    \n
Backbone.PageableCollection
( resp, queryParams, state, [options] ) : Object
Parse server response for server pagination state updates. ...

Parse server response for server pagination state updates. Not applicable\nunder infinite mode.

\n\n

This default implementation first checks whether the response has any\nstate object as documented in parse. If it exists, a state object is\nreturned by mapping the server state keys to this pageable collection\ninstance's query parameter keys using queryParams.

\n\n

It is NOT neccessary to return a full state object complete with all\nthe mappings defined in queryParams. Any state object resulted is merged\nwith a copy of the current pageable collection state and checked for\nsanity before actually updating. Most of the time, simply providing a new\ntotalRecords value is enough to trigger a full pagination state\nrecalculation.

\n\n
parseState: function (resp, queryParams, state, options) {\n  return {totalRecords: resp.total_entries};\n}\n
\n\n

If you want to use header fields use:

\n\n
parseState: function (resp, queryParams, state, options) {\n    return {totalRecords: options.xhr.getResponseHeader(\"X-total\")};\n}\n
\n\n

This method MUST return a new state object instead of directly\nmodifying the state object. The behavior of directly modifying state is\nundefined.

\n

Parameters

  • resp : Object

    The deserialized response data from the server.

    \n
  • queryParams : Object

    A copy of queryParams.

    \n
  • state : Object

    A copy of state.

    \n
  • options : Object (optional)

    The options passed through from\nparse. (backbone >= 0.9.10 only)

    \n

Returns

  • Object

    A new (partial) state object.

    \n
Backbone.PageableCollection
( pageSize, [options] ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Change the page size of this collection. ...

Change the page size of this collection.

\n\n

Under most if not all circumstances, you should call this method to\nchange the page size of a pageable collection because it will keep the\npagination state sane. By default, the method will recalculate the\ncurrent page number to one that will retain the current page's models\nwhen increasing the page size. When decreasing the page size, this method\nwill retain the last models to the current page that will fit into the\nsmaller page size.

\n\n

If options.first is true, changing the page size will also reset the\ncurrent page back to the first page instead of trying to be smart.

\n\n

For server mode operations, changing the page size will trigger a fetch\nand subsequently a reset event.

\n\n

For client mode operations, changing the page size will reset the\ncurrent page by recalculating the current page boundary on the client\nside.

\n\n

If options.fetch is true, a fetch can be forced if the collection is in\nclient mode.

\n

Parameters

  • pageSize : number

    The new page size to set to state.

    \n
  • options : Object (optional)

    fetch options.

    \n
    • first : boolean (optional)

      Reset the current page number to\nthe first page if true.

      \n

      Defaults to: false

    • fetch : boolean (optional)

      If true, force a fetch in client mode.

      \n

Returns

Throws

  • TypeError

    If pageSize is not a finite integer.

    \n
  • RangeError

    If pageSize is less than 1.

    \n
Backbone.PageableCollection
( sortKey, [order], [options] ) : Backbone.PageableCollectionchainable
Adjusts the sorting for this pageable collection. ...

Adjusts the sorting for this pageable collection.

\n\n

Given a sortKey and an order, sets state.sortKey and\nstate.order. A comparator can be applied on the client side to sort in\nthe order defined if options.side is \"client\". By default the\ncomparator is applied to the fullCollection. Set options.full to\nfalse to apply a comparator to the current page under any mode. Setting\nsortKey to null removes the comparator from both the current page and\nthe full collection.

\n\n

If a sortValue function is given, it will be passed the (model,\nsortKey) arguments and is used to extract a value from the model during\ncomparison sorts. If sortValue is not given, model.get(sortKey) is\nused for sorting.

\n

Parameters

  • sortKey : string

    See state.sortKey.

    \n
  • order : number (optional)

    See state.order.

    \n

    Defaults to: this.state.order

  • options : Object (optional)
    \n
    • side : \"server\"|\"client\" (optional)

      By default, \"client\" if\nmode is \"client\", \"server\" otherwise.

      \n
    • full : boolean (optional)

      Defaults to: true

    • sortValue : (function(Backbone.Model, string): Object) | string (optional)

Returns

Backbone.PageableCollection
( [mode], [options] ) : XMLHttpRequest|Backbone.PageableCollectionchainable
Switching between client, server and infinite mode. ...

Switching between client, server and infinite mode.

\n\n

If switching from client to server mode, the fullCollection is emptied\nfirst and then deleted and a fetch is immediately issued for the current\npage from the server. Pass false to options.fetch to skip fetching.

\n\n

If switching to infinite mode, and if options.models is given for an\narray of models, #links will be populated with a URL per page, using the\ndefault URL for this collection.

\n\n

If switching from server to client mode, all of the pages are immediately\nrefetched. If you have too many pages, you can pass false to\noptions.fetch to skip fetching.

\n\n

If switching to any mode from infinite mode, the #links will be deleted.

\n

Parameters

  • mode : \"server\"|\"client\"|\"infinite\" (optional)

    The mode to switch to.

    \n
  • options : Object (optional)
    \n
    • fetch : boolean (optional)

      If false, no fetching is done.

      \n

      Defaults to: true

    • resetState : boolean (optional)

      If 'false', the state is not\nreset, but checked for sanity instead.

      \n

      Defaults to: true

Returns

Backbone.PageableCollection
( method, model, [options] ) : XMLHttpRequest
Overidden to make getPage compatible with Zepto. ...

Overidden to make getPage compatible with Zepto.

\n

Parameters

  • method : string
    \n
  • model : Backbone.Model|Backbone.Collection
    \n
  • options : Object (optional)
    \n

Returns

  • XMLHttpRequest
    \n
Defined By

Static Methods

Backbone.PageableCollection
( ) : Backbone.PageableCollectionstatic
BROWSER ONLY\n\nIf you already have an object named PageableCollection attached to the\nBackbone module, you can use thi...

BROWSER ONLY

\n\n

If you already have an object named PageableCollection attached to the\nBackbone module, you can use this to return a local reference to this\nBackbone.PageableCollection class and reset the name\nBackbone.PageableCollection to its previous definition.

\n\n
// The left hand side gives you a reference to this\n// Backbone.PageableCollection implementation, the right hand side\n// resets Backbone.PageableCollection to your other\n// Backbone.PageableCollection.\nvar PageableCollection = Backbone.PageableCollection.noConflict();\n
\n

Returns

" });