FilterGroup
Mixin Extends:
Helper class representing a filter group.
Example:
// To get a list of FilterGroups use clinical6.get
import { clinical6, FilterGroup } from 'clinical6';
clinical6.get(FilterGroup).then(c => console.log(c));
// To get a single filter_group, you can also use clinical6
clinical6.get({ id: 5, type: 'filter_groups'});
// To save or insert, you can either use the .save() capability or clinical6
myFilterGroup.save(); // insert if no id, save if id
clinical6.insert(new FilterGroup({...}));
clinical6.update(myFilterGroup);
Constructor Summary
| Public Constructor | ||
| public |
constructor(json: Object) Constructor for helper class representing a FilterGroup |
|
Member Summary
| Public Members | ||
| public get |
|
|
| public set |
|
|
| public get |
|
|
| public set |
|
|
Method Summary
| Public Methods | ||
| public |
async save(): Promise<FilterGroup> Saves a filter group (insert if id doesn't exist, update if it does) |
|
Inherited Summary
| From class FilterGroupModel | ||
| public |
|
|
| public |
|
|
| public |
|
|
| public |
|
|
Public Constructors
public constructor(json: Object) source
Constructor for helper class representing a FilterGroup
Override:
FilterGroupModel#constructorParams:
| Name | Type | Attribute | Description |
| json | Object | json api response from server |
Public Members
Public Methods
public async save(): Promise<FilterGroup> source
Saves a filter group (insert if id doesn't exist, update if it does)
Example:
import { FilterGroup, clinical6 } from 'clinical6';
// Inserts new role (no existing id)
const filterGroup = new FilterGroup({
"type": "filter_groups",
"attributes": {
"operator": "and",
"created_at": "2018-04-19T19:16:12Z",
"updated_at": "2018-04-19T19:16:12Z"
},
"relationships": {
"cohort": {
"data": {
"id": "25",
"type": "cohorts"
}
}
}
});
filterGroup.save();
// Updates existing filter group (has existing id)
clinical6.get(FilterGroup).then(filterGroups => filterGroups[0].save());
Manual
Reference
Source
Test
