Summary
Feature

A special version of the Grid Summary feature. This feature displays a summary row in the grid footer.

For regular columns in the locked section - specify type of summary on columns, available types are:

Type	Description
`sum`	Sum of all values in the column
`add`	Alias for sum
`count`	Number of rows
`countNotEmpty`	Number of rows containing a value
`average`	Average of all values in the column
`function`	A custom function, used with store.reduce. Should take arguments (sum, record)

Columns can also specify a summaryRender to format the calculated sum.

To summarize events, either provide a renderer or use summaries

This feature is disabled by default.

Configs

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

renderer : Function
Renderer function for a single time axis tick. Should calculate a sum and return HTML as a result.

You should never modify any records inside this method.
```
new Scheduler({
    features : {
        summary : {
            renderer : ({ startDate, endDate, eventStore, resourceStore, events, element }) => {
                // return display value
                returns '<div>Renderer output</div>';
            }
        }
    }
});
```
Parameters
- context : Object
  
  Rendering context object
- startDate : Date
  
  Tick start date
- endDate : Date
  
  Tick end date
- events : EventModel[]
  
  Events which belong to the group
- eventStore : EventStore
  
  Event store
- resourceStore : ResourceStore
  
  Resource store
- element : HTMLElement
  
  Summary tick container
Returns

String
:

Html content

summaries : SchedulerSummaryOptions[]

Array of summary configs which consists of a label and a renderer function

new Scheduler({
    features : {
        summary : {
            summaries : [
                {
                    label : 'Label',
                    renderer : ({ startDate, endDate, eventStore, resourceStore, events, element }) => {
                        // return display value
                        returns '<div>Renderer output</div>';
                    }
                }
            ]
        }
    }
});

verticalSummaryColumnConfig : ColumnConfig

A config object for the Column used to contain the summary bar.

Properties

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

isSummary : Booleantrue

READONLY

static

ADVANCED

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

isSummary : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

updateTimelineSummaries( )

private

Updates summaries.

Type definitions

SchedulerSummaryOptions
Defines a summary, used by the Summary and GroupSummary features.
Properties
- label : String
  
  Label for the summary
- renderer : Function
  
  Function to calculate and render the summary value
- startDate : Date
  Start date
- endDate : Date
  End date
- eventStore : EventStore
  Event store
- resourceStore : ResourceStore
  Resource store
- events : EventModel[]
  Events
- resources : ResourceModel[]
  Resources
- groupRecord : Model
  Group record
- groupField : String
  Group field
- groupValue : Object
  Group value

id: summary

Source path

Scheduler/feature/Summary.js

Demo

examples/summary

Summary
Feature

See also

Configs

Parameters

Returns

Properties

Functions

Type definitions

Properties

Source path

Demo

Inheritance tree5

Mixins2

Contents

Summary Feature

See also

Configs

Parameters

Returns

Properties

Functions

Type definitions

Properties

Source path

Demo

Inheritance tree5

Mixins2

Contents

Summary
Feature