Interface BeforeSegmentExpandArgs

Arguments for the beforeSegmentExpand event. Emitted before a time segment is expanded.

Example

onBeforeSegmentExpand(args: BeforeSegmentExpandArgs) {
  // Could cancel expansion of certain segments
  if (args.eventCount > 100) {
    args.cancel = true;
    this.showToast('Too many events. Please filter first.');
  }
}
interface BeforeSegmentExpandArgs {
    cancel: boolean;
    endDate: Date;
    eventCount: number;
    label: string;
    segment: TimelineSegment;
    startDate: Date;
}

Hierarchy (view full)

Properties

cancel endDate eventCount label segment startDate

Properties

cancel

cancel: boolean

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

endDate

endDate: Date

End date of the segment.

eventCount

eventCount: number

Number of events in the segment.

label

label: string

The segment's display label.

segment

segment: TimelineSegment

The segment being interacted with.

startDate

startDate: Date

Start date of the segment.

Settings

Member Visibility

Theme

On This Page

cancelendDateeventCountlabelsegmentstartDate