DataGridXL - API

DataProgress

Description

The DataProgress (beta) displays and controls a "loading bar" in case DataStreamer is used to load large data sets.

NOTE: This class is in beta and should not be used in production.

Usage

Your DataGridXL instance contains a property dataProgress. (Only when the streamer option is used.)

javascript
// create DataGridXL instance
const grid = new DataGridXL(...);
// work with the DataProgress instance
grid.dataProgress.setProgress(0.5);
NOTE: You don't need to create a DataProgress instance yourself — it is provided by the grid automatically.

Methods

setProgress(message, value)

Set Progress Bar

Arguments

message
stringMessage to display
value
numberFraction to set progress bar
startBeforeProgress(message, targetProgressValue)

Start "Before Progress"

Arguments

message
stringMessage to display
targetProgressValue
numberProgress value (fraction) to animate towards
stopBeforeProgress()

Stop "Before Progress"

No generated events found for DataProgress.