GroupSummary
Feature

A special version of the Grid GroupSummary feature that enables summaries within scheduler. To use a single summary it is easiest to configure renderer, for multiple summaries see summaries.

This feature is disabled by default. It is not supported in vertical mode.

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 in a group summary row. Should calculate a sum and return HTML as a result.

You should never modify any records inside this method.
```
new Scheduler({
    features : {
        groupSummary : {
            renderer : ({ startDate, endDate, eventStore, resourceStore, events, resources, groupRecord, groupField, groupValue }) => {
                // 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
- resources : ResourceModel[]
  
  Resources which belong to the group
- eventStore : EventStore
  
  Event store
- resourceStore : ResourceStore
  
  Resource store
- groupRecord : Model
  
  Current groups header row record
- groupField : String
  
  Current groups field name
- groupValue : String
  
  Current groups value
Returns

String
:

Html content
showTooltip : Booleantrue

Show tooltip containing summary values and labels

summaries : SchedulerSummaryOptions[]

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

 summaries : [
     {
        label : 'Label',
        renderer : ({ startDate, endDate, eventStore, resourceStore, events, resources, groupRecord, groupField, groupValue }) => {
            // return display value
            returns '<div>Renderer output</div>';
        }
     }
 ]

Has a corresponding runtime summaries property.

tooltipTemplate : Function
Renderer function for the grouping summary tooltip.
```
new Scheduler({
    features : {
        groupSummary : {
            tooltipTemplate : ({ groupSummaryValues, startDate, endDate, eventStore, resourceStore, events, resources, groupRecord, groupField, groupValue }) => {
                return '<div>My custom tooltip html</div>';
            }
        }
    }
});
```
Parameters
- groupSummaryValues : GroupSummaryValue[]
  
  An array of object with label and value for each summary under the tooltip
- startDate : Date
  
  Tick start date
- endDate : Date
  
  Tick end date
- events : EventModel[]
  
  Events which belong to the group
- resources : ResourceModel[]
  
  Resources which belong to the group
- eventStore : EventStore
  
  Event store
- resourceStore : ResourceStore
  
  Resource store
- groupRecord : Model
  
  Current group's header row record
- groupField : String
  
  Current group's field name
- groupValue : String
  
  Current group's value
Returns

String
:

Html content

Properties

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

isGroupSummary : Booleantrue

READONLY

static

ADVANCED

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

summaries : SchedulerSummaryOptions[]

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

 summaries : [
     {
        label : 'Label',
        renderer : ({ startDate, endDate, eventStore, resourceStore, events, resources, groupRecord, groupField, groupValue }) => {
            // return display value
            returns '<div>Renderer output</div>';
        }
     }
 ]

Has a corresponding summaries config.

isGroupSummary : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

generateHtml( )

private

Called by parent class to fill timeaxis with summary contents. Generates tick "cells" and populates them with summaries.

<div class="b-time-axis-group-summary">
    <div class="b-time-axis-tick">
        <div class="b-timeaxix-summary-value">x</div>
        ...
    </div>
    ...
</div>

getTipHtml( )

private

Generates tooltip contents for hovered summary tick
onBeforeRenderRow( )

private

Called before rendering row contents, used to reset rows no longer used as group summary rows
render( )

private

Initialize tooltip on render
updateSummaryHtml( )

private

Overrides parents function to return correct summary count, used when sizing row

Type definitions

GroupSummaryValue
Represents a group summary value and label
Properties
- label : String
  
  The label config from a summary cell
- value : *
  
  The value returned from the summary cell renderer.

id: groupSummary

Source path

Scheduler/feature/GroupSummary.js

Demo

examples/groupsummary

GroupSummary
Feature

See also

Configs

Parameters

Returns

Parameters

Returns

Properties

Functions

Type definitions

Properties

Source path

Demo

Inheritance tree4

Mixins2

Contents

GroupSummary Feature

See also

Configs

Parameters

Returns

Parameters

Returns

Properties

Functions

Type definitions

Properties

Source path

Demo

Inheritance tree4

Mixins2

Contents

GroupSummary
Feature