# presentation-models > The Augmented.js Next - Presentation Dom Module. Latest version **3.1.6** (published 2020-07-18) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install presentation-models pnpm add presentation-models yarn add presentation-models bun add presentation-models ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.1.6 | | Published | 2020-07-18 | | First published | 2018-08-10 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 51.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Bob Warren | | Maintainers | thedocbwarren | | Keywords | augmentedjs, presentation | ## Links - npm: https://www.npmjs.com/package/presentation-models - Repository: https://github.com/Augmentedjs/presentation-models - Homepage: http://www.augmentedjs.com - Issues: https://github.com/Augmentedjs/presentation-models/issues - npm.io page: https://npm.io/package/presentation-models ## Dependencies (3) - [next-core-model](https://npm.io/package/next-core-model.md) ^3.1.5 - [presentation-request](https://npm.io/package/presentation-request.md) ^3.0.3 - [presentation-storage](https://npm.io/package/presentation-storage.md) ^2.5.7 ## Recent versions - 3.1.6 (latest) — 2020-07-18 - 3.1.5 — 2020-07-04 - 3.1.4 — 2020-06-09 - 3.1.3 — 2020-05-19 - 3.1.2 — 2020-05-19 - 3.1.1 — 2020-05-18 - 3.1.0 — 2020-05-17 - 3.0.2 — 2020-05-14 - 3.0.1 — 2020-05-13 - 3.0.0 — 2020-05-13 - 2.6.4 — 2019-06-23 - 2.6.3 — 2019-03-24 - 2.6.2 — 2019-03-10 - 2.6.1 — 2018-11-12 - 2.6.0 — 2018-09-16 - … 6 more at https://npm.io/package/presentation-models/versions ## README # presentation-models Augmented.js Presentation Models & Collections Module # API ### Table of Contents - [Model](#model) - [Parameters](#parameters) - [crossOrigin](#crossorigin) - [Properties](#properties) - [\_uri](#_uri) - [Properties](#properties-1) - [sync](#sync) - [Parameters](#parameters-1) - [fetch](#fetch) - [Parameters](#parameters-2) - [save](#save) - [Parameters](#parameters-3) - [update](#update) - [Parameters](#parameters-4) - [destroy](#destroy) - [Parameters](#parameters-5) - [Collection](#collection) - [Parameters](#parameters-6) - [\_uri](#_uri-1) - [Properties](#properties-2) - [sync](#sync-1) - [Parameters](#parameters-7) - [fetch](#fetch-1) - [Parameters](#parameters-8) - [save](#save-1) - [Parameters](#parameters-9) - [update](#update-1) - [Parameters](#parameters-10) - [destroy](#destroy-1) - [Parameters](#parameters-11) - [LocalStorageCollection](#localstoragecollection) - [Parameters](#parameters-12) - [key](#key) - [Properties](#properties-3) - [persist](#persist) - [Properties](#properties-4) - [namespace](#namespace) - [Properties](#properties-5) - [initialize](#initialize) - [Parameters](#parameters-13) - [init](#init) - [Parameters](#parameters-14) - [fetch](#fetch-2) - [Parameters](#parameters-15) - [save](#save-2) - [Parameters](#parameters-16) - [update](#update-2) - [Parameters](#parameters-17) - [destroy](#destroy-2) - [Parameters](#parameters-18) - [sync](#sync-2) - [Parameters](#parameters-19) - [PaginatedCollection](#paginatedcollection) - [Parameters](#parameters-20) - [setPageSize](#setpagesize) - [Parameters](#parameters-21) - [setPageSize](#setpagesize-1) - [Parameters](#parameters-22) - [setPageSize](#setpagesize-2) - [Parameters](#parameters-23) - [setCurrentPage](#setcurrentpage) - [Parameters](#parameters-24) - [fetch](#fetch-3) - [Parameters](#parameters-25) - [nextPage](#nextpage) - [previousPage](#previouspage) - [goToPage](#gotopage) - [Parameters](#parameters-26) - [firstPage](#firstpage) - [lastPage](#lastpage) - [refresh](#refresh) - [PaginationFactory](#paginationfactory) - [PAGINATION_API_TYPE](#pagination_api_type) - [Properties](#properties-6) - [getPaginatedCollection](#getpaginatedcollection) - [Parameters](#parameters-27) ## Model **Extends AbstractModel** Model
Supports: ### Parameters - `attributes` - `options` (optional, default `{}`) - `args` **...any** ### crossOrigin Cross Origin property #### Properties - `crossOrigin` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Cross Origin property ### \_uri #### Properties - `uri` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### save Save the model #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### update Update the model #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### destroy Destroy the model #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ## Collection **Extends AbstractCollection** Collection Class ### Parameters - `models` - `options` (optional, default `{}`) ### \_uri #### Properties - `uri` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The uri for the datasource (if applicable) ### sync Sync collection data to bound REST call #### Parameters - `method` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The method to Unsuccessfull - `model` **[Model](#model)** The model to Sync - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The options to pass (optional, default `{}`) Returns **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Returns a request function ### fetch Fetch the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### save Save the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### update Update the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### destroy Destroy the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The key ### persist is Persistant or not #### Properties - `persist` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Persistant property ### namespace The namespace #### Properties - `namespace` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** ### initialize Initialize the model with needed wireing #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### init Custom init method for the model (called at inititlize) #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### fetch Fetch the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### save Save the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### update Update the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Any options to pass ### destroy Destroy the collection #### Parameters - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Number of items in each page ### setCurrentPage Sets the current page #### Parameters - `page` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol)** GitHub API - `SOLR` **[Symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol)** SOLR API - `DATABASE` **[Symbol](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Collection models - `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Collection options --- _Source: https://npm.io/package/presentation-models · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._