Manual Reference Source Test
public class | source

Filter

Mixin Extends:

FilterModel, Helper

Helper class representing a filter.

Example:

// To get a list of Filters use clinical6.get
import { clinical6, Filter } from 'clinical6';
clinical6.get(Filter).then(c => console.log(c));

// To get a single filter, you can also use clinical6
clinical6.get({ id: 5, type: 'filters'});

// To save or insert, you can either use the .save() capability or clinical6
myFilter.save(); // insert if no id, save if id
clinical6.insert(new Filter({...}));
clinical6.update(myFilter);

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing a Filter

Member Summary

Public Members
public get

filterGroup: FitlerGroup

public set

Method Summary

Public Methods
public

async save(): Promise<Filter>

Saves a filter (insert if id doesn't exist, update if it does)

Inherited Summary

From class FilterModel
public
public
public
public
public
public
public

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing a Filter

Override:

FilterModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get filterGroup: FitlerGroup source

public set filterGroup: FilterGroup source

Public Methods

public async save(): Promise<Filter> source

Saves a filter (insert if id doesn't exist, update if it does)

Return:

Promise<Filter>

Returns a promise via ajax call.

Example:

import { Filter, clinical6 } from 'clinical6';

// Inserts new role (no existing id)
const filter = new Filter({...});
filter.save();

// Updates existing filter (has existing id)
clinical6.get(Filter).then(filters => filters[0].save());