ResourceStoreMixin
Mixin

This is a mixin for the ResourceStore functionality. It is consumed by the ResourceStore.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

loadPriority : Number

private

CrudManager must load stores in the correct order. Lowest first.
syncPriority : Number

private

CrudManager must sync stores in the correct order. Lowest first.

Properties

Properties are getters/setters or publicly accessible variables on this class

isResourceStoreMixin : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of ResourceStoreMixin class, or subclass thereof.

isResourceStoreMixin : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of ResourceStoreMixin class, or subclass thereof.
data : ResourceModelConfig
Applies a new dataset to the ResourceStore. Use it to plug externally fetched data into the store.

NOTE: References (events, assignments) on the resources are determined async by a calculation engine. Thus they cannot be directly accessed after assigning the new dataset.

For example:
```
resourceStore.data = [{ id }];
// resourceStore.first.events is not yet available
```
To guarantee references are available, wait for calculations for finish:
```
resourceStore.data = [{ id }];
await resourceStore.project.commitAsync();
// resourceStore.first.events is available
```
Alternatively use loadDataAsync() instead:
```
await resourceStore.loadDataAsync([{ id }]);
// resourceStore.first.events is available
```

Functions

Functions are methods available for calling on the class

getAvailableResources( startDate, endDate )
: ResourceModel[]

Returns all resources that have no events assigned during the specified time range.

add( records, silent )

: ResourceModel[]

Add resources to the store.

NOTE: References (events, assignments) on the resources are determined async by a calculation engine. Thus they cannot be directly accessed after using this function.

For example:

const [resource] = resourceStore.add({ id });
// resource.events is not yet available

To guarantee references are set up, wait for calculations for finish:

const [resource] = resourceStore.add({ id });
await resourceStore.project.commitAsync();
// resource.events is available (assuming EventStore is loaded and so on)

Alternatively use addAsync() instead:

const [resource] = await resourceStore.addAsync({ id });
// resource.events is available (assuming EventStore is loaded and so on)

addAsync( records, silent )
: ResourceModel[]

ASYNC
Add resources to the store and triggers calculations directly after. Await this function to have up to date references on the added resources.
```
const [resource] = await resourceStore.addAsync({ id });
// resource.events is available (assuming EventStore is loaded and so on)
```
loadDataAsync( data )
: Promise

ASYNC
Applies a new dataset to the ResourceStore and triggers calculations directly after. Use it to plug externally fetched data into the store.
```
await resourceStore.loadDataAsync([{ id }]);
// resourceStore.first.events is available
```

Source path

Scheduler/data/mixin/ResourceStoreMixin.js

Inheritance tree1

ResourceStoreMixin

ResourceStoreMixin Mixin