Class: Rest

Constructor

new Rest()

A rest api datasource

the constructor of the class

Copyright: schukai GmbH

Members

defaults

To set the options via the html tag the attribute data-monster-options must be used.

Properties

Name Type Description

templates

Object

Template definitions

Properties

Name	Type	Description
`main`	string	Main template

features

Object

Feature definitions

Properties

Name	Type	Description
`autoInit`	boolean	If true, the component is initialized automatically
`filter`	boolean	If true, the component is initialized automatically

autoInit

Object

Auto init definitions

Properties

Name	Type	Description
`intersectionObserver`	boolean	If true, the intersection observer is initialized automatically
`oneTime`	boolean	If true, the intersection observer is initialized only once

filter

Object

Filter definitions

Properties

Name	Type	Description
`id`	string	The id of the filter control

datatable

Object

Datatable definitions

Properties

Name	Type	Description
`id`	string	The id of the datatable control

response

Object

Response definitions

Properties

Name Type Description

path

Object

Path definitions (changed in 3.56.0)

Properties

Name	Type	Description
`message`	string	Path to the message (changed in 3.56.0)

read

Object

Read configuration

Properties

Name Type Description

url

string

The url of the rest api

method

string

The method of the rest api

parameters

Object

The parameters of the rest api

Properties

Name	Type	Description
`filter`	Object	The filter of the rest api
`orderBy`	Object	The order by of the rest api
`page`	Object	The page of the rest api

write

Object

Write configuration

See: https://monsterjs.org/en/doc/#configurate-a-monster-control The individual configuration values can be found in the table.

(static) instanceSymbol

This method is called by the instanceof operator.

Methods

assembleMethodSymbol() → {Monster.Components.Form.Form}

Returns:

Type:: Monster.Components.Form.Form

fetch() → {Promise.<never>|*}

Fetches the data from the rest api

Returns:

Type:: Promise.<never> | *

initIntersectionObserver() → {Monster.Components.Datatable.Datasource.Rest}

This method activates the intersection observer manually.

This method activates the intersection observer manually. For this purpose, the option autoInit.intersectionObserver must be set to false.

Returns:

Type:: Monster.Components.Datatable.Datasource.Rest

reload() → {Promise.<never>|*}

Deprecated: 2023-06-25

Returns:

Type:: Promise.<never> | *

setParameters(page, query, orderBy) → {Monster.Components.Datatable.Datasource.Rest}

Parameters:

Name	Type	Description
`page`	string
`query`	string
`orderBy`	string

Returns:

Type:: Monster.Components.Datatable.Datasource.Rest

write() → {Promise.<never>|*}

Fetches the data from the rest api

Returns:

Type:: Promise.<never> | *

(static) getCSSStyleSheet() → {Array.<CSSStyleSheet>}

Returns:

Type:: Array.<CSSStyleSheet>