FillHandle
Feature

This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over with values based on the values in the original selected range. This is similar to functionality normally seen in various spreadsheet applications.

Requires selectionMode.cell to be activated.

This feature is disabled by default

const grid = new Grid({
    features : {
        fillHandle : true
    }
});

This feature will not work properly when Store uses lazyLoad

Configs

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

allowCropping : Boolean

Set to true to enable the fill range to crop the original selected range. This clears the cells which were a part of the original selected range, but are no longer a part of the smaller range.
calculateFillValue : Function
Implement this function to be able to customize the value that cells will be filled with. Return undefined to use default calculations.
```
new Grid({
   features : {
       fillHandle : {
          calculateFillValue({cell, column, range, record}) {
             if(column.field === 'number') {
                return range.reduce(
                   (sum, location) => sum + location.record[location.column.field]
                );
             }
          }
       }
   }
});
```
Parameters
- data : Object
  
  Object containing information about current cell and fill value
- cell : GridLocation
  
  Current cell data
- column : Column
  
  Current cell column
- range : GridLocation[]
  
  Range from where to calculate values
- record : Model
  
  Current cell record
Returns

String/Number/Date
:

Value to fill current cell

Properties

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

isFillHandle : Booleantrue

READONLY

static

ADVANCED

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

isFillHandle : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

abort( )

Aborts an ongoing FillHandle drag operation
handleSelection( )

internal

Checks selection and sees to it that fill handle and border is drawn. Runs on next animation frame

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

beforeFillHandleDragStart

PREVENTABLE

ON-OWNER

Fired before dragging of the FillHandle starts, return false to prevent the drag operation.

Note that this event is triggered on the owning widget:
fillHandleBeforeDragFinalize

ASYNC

PREVENTABLE

ON-OWNER

Fired before the FillHandle dragging is finalized and values are applied to cells, return false to prevent the drag operation from applying data changes.

Note that this event is triggered on the owning widget:
fillHandleDrag

ON-OWNER

Fired while dragging the FillHandle.

Note that this event is triggered on the owning widget:
fillHandleDragAbort

ON-OWNER

Fired when a FillHandle drag operation is aborted.

Note that this event is triggered on the owning widget:
fillHandleDragEnd

ON-OWNER

Fired after a FillHandle drag operation.

Note that this event is triggered on the owning widget:
fillHandleDragStart

PREVENTABLE

ON-OWNER

Fired when dragging of the FillHandle starts.

Note that this event is triggered on the owning widget:

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onBeforeFillHandleDragStart

PREVENTABLE

ON-OWNER

Called before dragging of the FillHandle starts, return false to prevent the drag operation.

Note that this handler is called on the owning widget:
onFillHandleBeforeDragFinalize

ASYNC

PREVENTABLE

ON-OWNER

Called before the FillHandle dragging is finalized and values are applied to cells, return false to prevent the drag operation from applying data changes.

Note that this handler is called on the owning widget:
onFillHandleDrag

ON-OWNER

Called while dragging the FillHandle.

Note that this handler is called on the owning widget:
onFillHandleDragAbort

ON-OWNER

Called when a FillHandle drag operation is aborted.

Note that this handler is called on the owning widget:
onFillHandleDragEnd

ON-OWNER

Called after a FillHandle drag operation.

Note that this handler is called on the owning widget:
onFillHandleDragStart

PREVENTABLE

ON-OWNER

Called when dragging of the FillHandle starts.

Note that this handler is called on the owning widget:

CSS variables

CSS variables that can be set to adjust appearance

Name	Description
--b-fill-handle-handle-size	Size of the fill handle

FillHandle
Feature

See also

Configs

Parameters

Returns

Properties

Functions

Events

Event handlers

CSS variables

Source path

Inheritance tree3

Mixins2

Contents

FillHandle Feature

See also

Configs

Parameters

Returns

Properties

Functions

Events

Event handlers

CSS variables

Source path

Inheritance tree3

Mixins2

Contents

FillHandle
Feature