Interface AfterSegmentExpandArgs

Arguments for the afterSegmentExpand event. Emitted after a time segment is expanded.

interface AfterSegmentExpandArgs {
    endDate: Date;
    errorMessage?: string;
    eventCount: number;
    label: string;
    segment: TimelineSegment;
    startDate: Date;
    success: boolean;
}

Hierarchy (view full)

Properties

endDate errorMessage? eventCount label segment startDate success

Properties

endDate

endDate: Date

End date of the segment.

Optional errorMessage

errorMessage?: string

Error message if the operation failed. Only populated when success is false.

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.

success

success: boolean

Whether the operation completed successfully. Will be false if an error occurred during the operation.

Settings

Member Visibility

Theme

On This Page

endDateerrorMessageeventCountlabelsegmentstartDatesuccess