Interface BeforeSegmentCollapseArgs

Arguments for the beforeSegmentCollapse event. Emitted before a time segment is collapsed.

interface BeforeSegmentCollapseArgs {
    cancel: boolean;
    endDate: Date;
    eventCount: number;
    label: string;
    segment: TimelineSegment;
    startDate: Date;
}

Properties

cancel: boolean

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

endDate: Date

End date of the segment.

eventCount: number

Number of events in the segment.

label: string

The segment's display label.

The segment being interacted with.

startDate: Date

Start date of the segment.