presentation-models v3.1.6

presentation-models

Augmented.js Presentation Models & Collections Module

API

Table of Contents

• Model
  • Parameters
  • crossOrigin
    • Properties
  • _uri
    • Properties
  • sync
    • Parameters
  • fetch
    • Parameters
  • save
    • Parameters
  • update
    • Parameters
  • destroy
    • Parameters
• Collection
  • Parameters
  • _uri
    • Properties
  • sync
    • Parameters
  • fetch
    • Parameters
  • save
    • Parameters
  • update
    • Parameters
  • destroy
    • Parameters
• LocalStorageCollection
  • Parameters
  • key
    • Properties
  • persist
    • Properties
  • namespace
    • Properties
  • initialize
    • Parameters
  • init
    • Parameters
  • fetch
    • Parameters
  • save
    • Parameters
  • update
    • Parameters
  • destroy
    • Parameters
  • sync
    • Parameters
• PaginatedCollection
  • Parameters
  • setPageSize
    • Parameters
  • setPageSize
    • Parameters
  • setPageSize
    • Parameters
  • setCurrentPage
    • Parameters
  • fetch
    • Parameters
  • nextPage
  • previousPage
  • goToPage
    • Parameters
  • firstPage
  • lastPage
  • refresh
• PaginationFactory
• PAGINATION_API_TYPE
  • Properties
• getPaginatedCollection
  • Parameters

Model

Extends AbstractModel

Model Supports:

Parameters

• attributes
• options (optional, default {})
• args ...any

crossOrigin

Cross Origin property

Properties

• crossOrigin boolean Cross Origin property

_uri

Properties

• uri string The uri for the datasource (if applicable)

sync

sync - Sync model data to bound REST call

Parameters

• method (optional, default "READ")
• model
• options (optional, default {})

fetch

Fetch the model

Parameters

• options object Any options to pass

save

Save the model

Parameters

• options object Any options to pass

update

Update the model

Parameters

• options object Any options to pass

destroy

Destroy the model

Parameters

• options object Any options to pass

Collection

Extends AbstractCollection

Collection Class

Parameters

• models
• options (optional, default {})

_uri

Properties

• uri string The uri for the datasource (if applicable)

sync

Sync collection data to bound REST call

Parameters

• method string The method to Unsuccessfull
• model Model The model to Sync
• options object The options to pass (optional, default {})

Returns function Returns a request function

fetch

Fetch the collection

Parameters

• options object Any options to pass

save

Save the collection

Parameters

• options object Any options to pass

update

Update the collection

Parameters

• options object Any options to pass

destroy

Destroy the collection

Parameters

• options object Any options to pass

LocalStorageCollection

Extends AbstractCollection

A local storage-based Collection

Parameters

• models
• options (optional, default {})

key

Base key name for the collection (simular to url for rest-based)

Properties

• key string The key

persist

is Persistant or not

Properties

• persist boolean Persistant property

namespace

The namespace

Properties

• namespace boolean

initialize

Initialize the model with needed wireing

Parameters

• options object Any options to pass

init

Custom init method for the model (called at inititlize)

Parameters

• options object Any options to pass

fetch

Fetch the collection

Parameters

• options object Any options to pass

save

Save the collection

Parameters

• options object Any options to pass

update

Update the collection

Parameters

• options object Any options to pass

destroy

Destroy the collection

Parameters

• options object Any options to pass

sync

Sync method for Collection

Parameters

• method (optional, default "READ")
• model
• options (optional, default {})

PaginatedCollection

Extends Collection

Paginated Collection Class - A Collection that handles pagination from client or server-side

Parameters

• models
• options (optional, default {})

setPageSize

Current page for the collection

Parameters

• size

setPageSize

Total pages for the collection

Parameters

• size

setPageSize

Sets the number of items in a page

Parameters

• size number Number of items in each page

setCurrentPage

Sets the current page

Parameters

• page number Current page in collection

fetch

Collection.fetch - rewritten fetch method from Backbone.Collection.fetch

Parameters

• options

nextPage

Moves to the next page

previousPage

Moves to the previous page

goToPage

Goes to page

Parameters

• page number Page to go to

firstPage

Moves to the first page

lastPage

Moves to the last page

refresh

Refreshes the collection

PaginationFactory

Pagination factory for returning pagination collections of an API type

PAGINATION_API_TYPE

Types of pagination API

Properties

• GITHUB Symbol GitHub API
• SOLR Symbol SOLR API
• DATABASE Symbol Database-like API

getPaginatedCollection

Get a pagination collection of type

Parameters

• apiType Pagination.PAGINATION_API_TYPE The API type to return an instance of
• data object Collection models
• options object Collection options