templates

class janim.timeline.templates.SourceTimeline(*args, **kwargs)

Bases: Timeline

Compared to Timeline, this will display the source code in the background.

source_object() → object

build(*, quiet=False, hide_subtitles=False, show_debug_notice=False) → BuiltTimeline

Build the animation and return it

class janim.timeline.templates.ListedTimelines(*args, **kwargs)

Bases: Timeline

Specify a group of Timeline implementations and play them in sequence

Example:

class Section0(Timeline):
    def construct(self):
        ...

class Section1(Timeline):
    def construct(self):
        ...

class Section2(Timeline):
    def construct(self):
        ...

class Sections(ListedTimelines):
    includes = [Section1, Section2]

includes: list[type[Timeline]] = []

construct()

class janim.timeline.templates.AboveTimelines(*args, **kwargs)

Bases: ListedTimelines

Play all Timeline implementations previously defined in the same file, in order

Example:

class Section0(Timeline):
    def construct(self):
        ...

class Section1(Timeline):
    def construct(self):
        ...

class Section2(Timeline):
    def construct(self):
        ...

class Sections(AboveTimelines):
    pass

You can additionally use excludes to specify excluded items

Example:

...

class Sections(AboveTimelines):
    excludes = [Section0]

excludes: list[type[Timeline]] = []

construct()