Interface BeforeLoadArgs

Arguments for the beforeLoad event. Emitted before data loading begins.

Example

onBeforeLoad(args: BeforeLoadArgs) {
  if (this.isOffline) {
    args.cancel = true;
    this.showOfflineMessage();
  }
}
interface BeforeLoadArgs {
    batchSize?: number;
    cancel: boolean;
    groups: TimelineGroup<any>[];
    isIncremental: boolean;
    offset?: number;
}

Hierarchy (view full)

Properties

batchSize? cancel groups isIncremental offset?

Properties

Optional batchSize

batchSize?: number

For incremental loads, the batch size.

cancel

cancel: boolean

Set to true to cancel the default behavior. Default value is false.

groups

groups: TimelineGroup<any>[]

The groups that will be loaded.

isIncremental

isIncremental: boolean

Whether this is an incremental load (virtual scroll) or a full refresh.

Optional offset

offset?: number

For incremental loads, the current offset.

Settings

Member Visibility

Theme

On This Page

batchSizecancelgroupsisIncrementaloffset