Class SlideDeck

elsie.slides.slidedeck.SlideDeck

Presentation containing slides.

Declaration

class SlideDeck(StyleContainer)

source link

Documentation

Methods

▶ def __init__(self, width=1024, height=768, *, debug=False, pygments_theme="default", ...) override

def __init__(

self,

width=1024,

height=768,

debug=False,

pygments_theme="default",

bg_color: str = None,

backend: Backend = None,

cache_dir=DEFAULT_CACHE_DIR,

name_policy="auto",

)

source link

This method overrides elsie.text.stylecontainer.StyleContainer.__init__.

Parameters

width : int
```
Width of the slides.
```
height : int
```
Height of the slides.
```
debug : bool
```
Enable debugging mode.
```
pygments_theme : str
```
Theme used for syntax highlighting.
```
bg_color : str
```
Default background color of each slide.
```

cache_dir : str

Directory where slide cache will be stored.

name_policy : {"auto", "ignore", "replace", "unique"}

Policy used to handle slides with the same name.
"unique" -> SlideDeck with the same name are not allowed.
"replace" -> If there was a slide with the same name, it will be removed prior to
adding the new slide.
"ignore" -> Slide names are ignored.
"auto" -> Uses "replace" behaviour when running inside Jupyter, otherwise uses
"unique".

backend : Backend

Backend used for computating layout and rendering slides.
The default backend is InkscapeBackend.

▷ def add_pdf(self, filename: str)
Adds raw PDF into the resulting slides.
source link
▷ def get_slide_by_name(self, name: str) -> Union[Slide, None]
Returns a slide with the given name.
source link
▶ def new_slide(self, name=None, *, bg_color=None, view_box=None, debug_boxes=False) -> box.Box
Creates a new slide and returns its root Box.
source link
Parameters
- name : str
```
Name of the slide
```
- bg_color : str
```
Background color of the slide.
```
- view_box : tuple
```
SVG viewbox of the slide. Has to be a 4-element tuple (x, y, width, height).
```
- debug_boxes : bool
```
If True, debugging information about each box will be drawn on the slide.
```

▶ def render(self, ...) -> Union[None, List[RenderUnit], List[str]]

Renders the presentation into a PDF file.

def render(

self,

output: Union[str, None] = "slides.pdf",

return_units=False,

export_type="pdf",

pdf_merger="pypdf",

slide_postprocessing: Callable[[List[box.Box]], ...] = None,

prune_cache=True,

save_cache=True,

select_slides: List[Slide] = None,

slides_per_page: Tuple[int, int] = None,

) -> Union[None, List[RenderUnit], List[str]]

source link

Parameters

output : str

Output PDF file path where the slides will be rendered.

return_units : bool

If True, this function will return a list of (either SVG or PDF) render units.
In this case the presentation will not be rendered into the `output` file.

export_type : str

Output format of slides; it supports all formats supported by Inkscape export
(e.g. "pdf", "png", etc.)
If export_type is "pdf" then it is merged into one
final PDF file defined by parameter `output`.
For other formats, `output` is ignored and returns a list of filenames
with exported files. The files are placed into cache directory and could be
removed by another call of render with `prune_cache=True`.

pdf_merger : {"pypdf", "pdfunite"}

Method used to merge PDFs together. It is used when export_type is "pdf".

slide_postprocessing : Callable[[List[Box]], ...]

This function will be called just before the slides are rendered.
It will be passed a list of root boxes, one for each slide.

select_slides : List[Slide]

List of slides to be rendered.
If `None`, then all slides are rendered.

slides_per_page : Tuple[int, int]

Must be a 2-element tuple (R, C) of integers.
Renders a grid of (R, C) slides per each page.
If not defined, then each slide is rendered on a single page.

prune_cache : bool

If True, then after a successful render, all data that was not used for this render
will be removed from the cache directory.
Otherwise unused data will not be touched.

save_cache : bool

If True, the query cache will be updated when all queries are computed.

▶ def slide(self, name=None, *, bg_color=None, view_box=None, debug_boxes=False)

Decorator which creates a new slide and passes its root box to the decorated function.

source link

Examples:
slides = elsie.SlideDeck()

@slides.slide()
def slide1(slide: elsie.Box):
    slide.box().text("Hello")

Parameters

name : str

Name of the slide.
If `name` is `None`, the name of the slide will be set to the name of the decorated
function.

bg_color : str
```
Background color of the slide.
```

view_box : tuple

SVG viewbox of the slide. Has to be a 4-element tuple (x, y, width, height).

debug_boxes : bool

If True, debugging information about each box will be drawn on the slide.

Inherited methods

Methods inherited from elsie.text.stylecontainer.StyleContainer:
get_style, has_style, set_style, update_style

Reexports

Imported in elsie.ext.export.
Imported in elsie.