LazyLoadCrudManager
Mixin

Mixin for CrudManager that handles lazy loading.

No results

Configs

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

lazyLoad : Boolean/Object
If set to true, or a config object, this makes the CrudManager load records only when needed. When a record or a date range that is not already loaded is requested, a load request will be made to the specified URL. More more details about lazy loading, see the guide
Parameters
- lazyLoad : Object
  
  Lazy load config
- chunkSize : Number
  
  The number of records to be loaded before and after the requested index (only affects the ResourceStore).
- bufferUnit : DurationUnit
  
  Used together with bufferAmount to calculate the start and end dates of each load request. The value is added to the current visible start or end date. Defaults to the visible time span length (does not affect ResourceStore).
- bufferAmount : Number
  
  See bufferUnit
Has a corresponding runtime lazyLoad property.
pageSize : Number

The number of Resource records each page should contain, when using remotePaging
remotePaging : Boolean
If set to true, this makes the CrudManager load pages of data, instead of loading the complete dataset at once. The requests made to the loadUrl will contain params with info about the current dataset being requested:
- page - The resource page
- pageSize - The resource page size
- startDate - The start date of the calculated timespan
- endDate - The end date of the calculated timespan
For more details about paging, see the guide
requestData : Function

ASYNC
When the CrudManager/Project is configured with lazyLoad set to true, you can configure your own data fetching logic by implementing this function. Doing this will override the built-in fetching mechanism using the loadUrl.

When implementing this, it is expected that what is returned is an object fulfilling the contract of a regular CrudManager/Project load call.
Parameters
- params : LazyLoadCrudManagerRequestParams
  
  Object containing info of what data is requested
Returns

CrudManagerRequestResponse

Properties

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

isLazyLoadCrudManager : Booleantrue

READONLY

static

ADVANCED

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

isLazyLoadCrudManager : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of LazyLoadCrudManager class, or subclass thereof.
lazyLoad : Boolean/Object

If set to true, or a config object, this makes the CrudManager load records only when needed. When a record or a date range that is not already loaded is requested, a load request will be made to the specified URL. More more details about lazy loading, see the guide

Has a corresponding lazyLoad config.

Type definitions

LazyLoadCrudManagerRequestParams
An object containing details about the requested data
Properties
- startIndex : Number
  
  The index of the first record being requested
- count : Number
  
  The number of records being requested
- startDate : Date
  
  The startDate of the requested date range (only if applicable)
- endDate : Date
  
  The endDate of the requested date range (only if applicable)
- parentId : String/Number
  
  The parentId for which to load children (only if Resource store is a tree store)
- stores : String[]
  
  The id's of the stores which the CrudManager requests data for
CrudManagerRequestResponse
An object containing details about the received data used for lazy and paged loading
Properties
- resources : Object
  Resources
- rows : Object[]
  Rows
- total : Number
  Total
- events : Object
  Events
- rows : Object[]
  Rows
- assignments : Object
  Assignments
- rows : Object[]
  Rows
- resourceTimeRanges : Object
  Resource time ranges
- rows : Object[]
  Rows
- timeRanges : Object
  Time ranges
- rows : Object[]
  Rows
- calendars : Object
  Calendars
- rows : Object[]
  Rows

Source path

Scheduler/crud/mixin/LazyLoadCrudManager.js

Inheritance tree1

LazyLoadCrudManager

LazyLoadCrudManager Mixin

Configs

Parameters

Parameters

Returns

Properties

Type definitions

Properties

Properties

Source path

Inheritance tree1

Contents

LazyLoadCrudManager
Mixin