module timelinelib.canvas.data.timeperiod

class timelinelib.canvas.data.timeperiod.TimePeriod

Bases: object

Represents a period in time using a start and end time.

This is used both to store the time period for an event and for storing the currently displayed time period in the GUI.

__init__(start_time, end_time)

Initialize self. See help(type(self)) for accurate signature.

property start_time

property end_time

property start_and_end_time

__eq__(other)

Return self==value.

__ne__(other)

Return self!=value.

__repr__()

Return repr(self).

get_time_at_percent(percent)

get_start_time()

get_end_time()

set_start_time(time)

set_end_time(time)

start_to_start(time_period)

start_to_end(time_period)

end_to_start(time_period)

end_to_end(time_period)

update(start_time, end_time, start_delta=None, end_delta=None)

inside(time)

Return True if the given time is inside this period or on the border, otherwise False.

distance_to(time_period)

overlaps(time_period)

outside_period(time_period)

inside_period(time_period)

starts_after(time)

starts_before(time)

ends_before(time)

ends_after(time)

ends_at(time)

is_period()

Return True if this time period is longer than just a point in time, otherwise False.

mean_time()

Return the time in the middle if this time period is longer than just a point in time, otherwise the point in time for this time period.

duration()

zoom(times, ratio=0.5)

move(direction)

Move this time period one 10th to the given direction.

Direction should be -1 for moving to the left or 1 for moving to the right.

move_delta(delta)

delta()

Return the length of this time period as a timedelta object.

center(time)

has_nonzero_time()

exception timelinelib.canvas.data.timeperiod.TimeOutOfRangeLeftError

Bases: ValueError

exception timelinelib.canvas.data.timeperiod.TimeOutOfRangeRightError

Bases: ValueError

timelinelib.canvas.data.timeperiod.time_period_center(time, length)

TimePeriod factory method.

Return a time period with the given length (represented as a timedelta) centered around time.