presentation-table

Augmented.js Presentation Table View Module

API

$3

- AutomaticTable
- Parameters
- Examples
- theme
- Properties
- linkable
- Properties
- links
- Properties
- Examples
- selectable
- Properties
- sortable
- Properties
- sortStyle
- Properties
- display
- Properties
- renderPaginationControl
- Properties
- paginationAPI
- Properties
- description
- Properties
- localStorage
- Properties
- localStorageKey
- Properties
- editable
- Properties
- crossOrigin
- Properties
- lineNumbers
- Properties
- uri
- Properties
- isInitalized
- Properties
- pageControlBound
- Properties
- schema
- Properties
- name
- Properties
- setTheme
- Parameters
- rowLink
- Parameters
- sortBy
- Parameters
- currentPage
- totalPages
- nextPage
- previousPage
- goToPage
- Parameters
- firstPage
- lastPage
- editCell
- Parameters
- copyCell
- Parameters
- clearCell
- Parameters
- render
- retrieveSchema
- Parameters
- fetch
- save
- Parameters
- populate
- Parameters
- clear
- refresh
- compileTemplate
- setURI
- Parameters
- setSchema
- Parameters
- showProgressBar
- Parameters
- showMessage
- Parameters
- validate
- isValid
- remove
- getSelected
- Parameters
- getSelectedAsJSON
- getSelectedIndex
- removeRows
- Parameters
- removeSelectedRows
- addRow
- Parameters
- exportTo
- Parameters
- BigDataTable
- Parameters
- EditableBigDataTable
- Parameters
- EditableLocalStorageTable
- Parameters
- EditableTable
- Parameters
- LocalStorageTable
- Parameters
- Spreadsheet
- Parameters
- \_generate
- \_generate

AutomaticTable

Extends DecoratorView

AutomaticTable

Creates a table automatically via a schema for defintion and a uri/json for data

$3

- options (optional, default {})

$3

``javascript
const at = new AutomaticTable({
schema: schema,
el: "#autoTable",
crossOrigin: false,
sortable: true,
lineNumbers: true,
editable: true,
uri: "/example/data/table.json",
messagePosition: "top", // or bottom
theme: "material",
linkable: true,
links: {
wholeRow: true,
column: "",
link: "rowLink"
},
fetchOnStart: false
});
`

$3

The theme property - The theme of this table (default is 'material')

#### Properties

- theme string The theme of this table

$3

The linkable property - enable links in a row (only works in non-editable tables)

#### Properties

- linkable boolean enable/disable linking a row

$3

The links property - setup linking structure for links in a row

#### Properties

- linkable boolean enable/disable linking a row

#### Examples

`javascript
links: {
wholeRow: false, // link whole row vs column
column: "name", // name of column
link: "rowLink" // callback or method in class
}
`

$3

The selectable property - enable selecting a row in table

#### Properties

- selectable boolean enable/disable selecting a row

$3

The sortable property - enable sorting in table

#### Properties

- sortable boolean enable sorting in the table

$3

The sortStyle property - setup the sort API

#### Properties

- sortStyle string setup the sort API

$3

Fields to display - null will display all

#### Properties

- display array Fields to display

$3

The renderPaginationControl property - render the pagination control

#### Properties

- renderPaginationControl boolean render the pagination control

$3

The paginationAPI property - setup the paginatin API to use

#### Properties

- paginationAPI PaginationFactory.type the pagination API to use

$3

The description property

#### Properties

- description string The description of the table

$3

The localStorage property - enables localStorage

#### Properties

- localStorage boolean The localStorage property

$3

The localStorageKey property - set the key for use in storage

#### Properties

- localStorageKey string The localStorage key property

$3

The editable property - enables editing of cells

#### Properties

- editable boolean The editable property

$3

The crossOrigin property - enables cross origin fetch

#### Properties

- crossOrigin boolean The crossOrigin property

$3

The lineNumber property - turns on line numbers

#### Properties

- lineNumbers boolean The lineNumbers property

$3

The URI property

#### Properties

- uri string The URI property

$3

The initialized property

#### Properties

- isInitalized boolean The initialized property

$3

The pageControlBound property

#### Properties

- pageControlBound boolean is the pagecontrol bound

$3

The schema property - the defining schema

#### Properties

- schema object The schema

$3

The name property

#### Properties

- name string The name of the table

$3

The theme of the table

#### Parameters

- theme string name of the theme

$3

The default rowlink function callback called by row to format a link

#### Parameters

- row array The row data

Returns string Returns the link uri

$3

Sort the table by a key (sent via a UI Event)

#### Parameters

- key string The key to sort by

$3

Return the current page number

Returns number The current page number

$3

Return the total pages

Returns number The total pages

$3

Advance to the next page

$3

Return to the previous page

$3

Go to a specific page

#### Parameters

- page number The page to go to

$3

Return to the first page

$3

Advance to the last page

$3

Edit a cell at the row and column specified

#### Parameters

- row number The row
- col number The column
- value any The value to set

$3

Copy a cell at the row and column to another

#### Parameters

- row1 number The 'from' row
- col1 number The 'from' column
- row2 number The 'to' row
- col2 number The 'to' column

$3

Clear a cell at the row and column specified

#### Parameters

- row number The row
- col number The column

$3

Render the table

Returns object Returns the view context ('this')

$3

Fetch the schema from the source URI

#### Parameters

- uri {string} the URI to fetch from

$3

Fetch the data from the source URI

$3

Save the data to the source
This only functions if the table is editable

#### Parameters

- override boolean Save even if not editable

Returns any Returns true if succesfull

$3

Populate the data in the table

#### Parameters

- source array The source data array

$3

Clear all the data in the table

$3

- **See: AutomaticTable.render
**

Refresh the table (Same as render)

Returns object Returns the view context ('this')

$3

An overridable template compile

Returns string Returns the template

$3

Sets the URI

#### Parameters

- uri string The URI

$3

Sets the schema

#### Parameters

- schema object The JSON schema of the dataset

$3

Enable/Disable the progress bar

#### Parameters

- show boolean Show or Hide the progress bar

$3

Show a message related to the table

#### Parameters

- message string Some message to display

$3

Validate the table

Returns boolean Returns true on success of validation

$3

Is the table valid

Returns boolean Returns true if valid

$3

Remove the table and all binds

Returns any Returns the context (this)

$3

Gets the selected models

#### Parameters

- json boolean convert to array of objects

Returns Array Returns array of selected rows (models)

$3

Gets the selected models as JSON

Returns Array Returns array of selected rows (JSON Objects)

$3

Gets the selected row indexes

Returns Array Returns array of selected rows (indexes)

$3

Removes the models

#### Parameters

- rows Array Models of the rows to remove

$3

Removes the selected models

$3

adds a row to the table

#### Parameters

- model Model The model to add

$3

Export the table data in requested format

#### Parameters

- type string The type requested (csv, tsv, json, or html) html is default

Returns string The table data in requested format

BigDataTable

Extends AutomaticTable

Instance class preconfigured for sorting and pagination

$3

- options

EditableBigDataTable

Extends AutomaticTable

Instance class preconfigured for sorting and pagination

$3

- options

EditableLocalStorageTable

Extends AutomaticTable

Instance class preconfigured for editing, sorting, from local storage

$3

- options

EditableTable

Extends AutomaticTable

Instance class preconfigured for editing

$3

- options

LocalStorageTable

Extends AutomaticTable

Instance class preconfigured for local storage-based table

$3

- options

Spreadsheet

Extends AutomaticTable

Instance class preconfigured for editing for use as a Spreadsheet.

If a propery for length is not specified, it will buffer 10 lines for editing.

$3

- options`

$3

$3