PPTXSlideLayout

class ansys.dynamicreporting.core.serverless.template.PPTXSlideLayout(*args, **kwargs)

Bases: Layout

Layout defining settings for an individual PPTX slide.

Methods

PPTXSlideLayout.add_filter([filter_str])	Append filter_str to the current item filter.
PPTXSlideLayout.add_params(new_params)	Merge new_params into the existing params dictionary.
PPTXSlideLayout.add_properties(new_props)	Alias for add_property().
PPTXSlideLayout.add_property(new_props)	Merge new_props into the existing properties sub-dictionary.
PPTXSlideLayout.add_sort_fields(sort_field)	Extend the existing sort field list with sort_field.
PPTXSlideLayout.add_tag(tag[, value])	Add or update a single tag.
PPTXSlideLayout.as_dict([recursive])	Serialize the model into a plain dictionary.
PPTXSlideLayout.create(**kwargs)	Factory-style creation that dispatches to the correct subclass.
PPTXSlideLayout.delete()	Delete this object from the database.
PPTXSlideLayout.filter(**kwargs)	Return a collection of templates, scoped by subclass report_type.
PPTXSlideLayout.find([query])	Search for templates using an ADR query string.
PPTXSlideLayout.get(**kwargs)	Retrieve a single template, scoped by subclass report_type.
PPTXSlideLayout.get_column_count()	Return the number of columns in this layout.
PPTXSlideLayout.get_column_widths()	Return the list of column width factors.
PPTXSlideLayout.get_comments()	Return any user comments associated with this layout.
PPTXSlideLayout.get_filter()	Return the raw item filter string.
PPTXSlideLayout.get_filter_mode()	Return the filter mode ('items', 'root_replace', or 'root_append').
PPTXSlideLayout.get_html()	Return the raw HTML fragment stored on this layout.
PPTXSlideLayout.get_params()	Deserialize params into a Python dictionary.
PPTXSlideLayout.get_property()	Return the properties sub-dictionary from params (if present).
PPTXSlideLayout.get_skip()	Return the 'skip empty' flag (0 or 1).
PPTXSlideLayout.get_sort_fields()	Return the configured sort fields list, if any.
PPTXSlideLayout.get_sort_selection()	Return the sort selection mode ('all', 'first', or 'last').
PPTXSlideLayout.get_tags()	Return the raw tag string stored on this object.
PPTXSlideLayout.get_transpose()	Return the table transpose flag (0 or 1).
PPTXSlideLayout.reinit()	Reset the in-memory ORM state for this object.
PPTXSlideLayout.rem_tag(tag)	Remove a tag by key, if it exists.
PPTXSlideLayout.remove_tag(tag)	Alias for rem_tag() for backwards compatibility.
PPTXSlideLayout.render(*[, context, ...])	Render the template to HTML.
PPTXSlideLayout.render_pdf(*[, context, ...])	Render the template to a PDF byte stream.
PPTXSlideLayout.reorder_child(...)	Move a child template to a new position in children.
PPTXSlideLayout.reorder_children()	Reorder the children list based on the children_order string.
PPTXSlideLayout.save(**kwargs)	Save the template, enforcing parent/child invariants.
PPTXSlideLayout.set_column_count(value)	Set the number of columns in this layout.
PPTXSlideLayout.set_column_widths(value)	Set the list of column width factors.
PPTXSlideLayout.set_comments([value])	Set user comments for this layout.
PPTXSlideLayout.set_filter(filter_str)	Replace the current item filter with filter_str.
PPTXSlideLayout.set_filter_mode([value])	Set the filter mode.
PPTXSlideLayout.set_html([value])	Set the HTML fragment for this layout.
PPTXSlideLayout.set_params(new_params)	Replace the current params dictionary.
PPTXSlideLayout.set_property(new_props)	Replace the properties sub-dictionary with new_props.
PPTXSlideLayout.set_skip([value])	Set whether empty content should be skipped (0 or 1).
PPTXSlideLayout.set_sort_fields(sort_field)	Set the full list of sort fields.
PPTXSlideLayout.set_sort_selection([value])	Set the sort selection mode.
PPTXSlideLayout.set_tags(tag_str)	Replace all tags with the given tag string.
PPTXSlideLayout.set_transpose([value])	Set whether tabular data should be transposed (0 or 1).
PPTXSlideLayout.to_dict()	Return a JSON-serializable dictionary for the full template tree.
PPTXSlideLayout.to_json(filename)	Dump the full template tree to a JSON file.
PPTXSlideLayout.update_children_order()	Update children_order from the current children list.

Attributes

PPTXSlideLayout.children_order	Comma-separated list of child GUIDs in desired order.
PPTXSlideLayout.db	Database alias in which this object is stored.
PPTXSlideLayout.exclude_from_toc
PPTXSlideLayout.item_filter	Default ADR query string used to select items for this template.
PPTXSlideLayout.master	Whether this template is a root (no parent).
PPTXSlideLayout.name	Human-readable name of the template.
PPTXSlideLayout.params	JSON-encoded parameter dictionary backing this template configuration.
PPTXSlideLayout.parent	Parent template in the hierarchy, or None for a root template.
PPTXSlideLayout.report_type	Canonical type string used for subclass dispatch and filtering.
PPTXSlideLayout.saved	Whether this object has been successfully saved to the database.
PPTXSlideLayout.source_slide
PPTXSlideLayout.tags	Tag string used to group and filter objects.
PPTXSlideLayout.type	Alias for report_type for parity with items.
PPTXSlideLayout.date	Template creation timestamp.
PPTXSlideLayout.children	Ordered list of child templates that form this template's subtree.
PPTXSlideLayout.guid	Globally unique identifier for this object.

exception DoesNotExist(extra_detail: str = None)

Bases: DoesNotExist

exception IntegrityError(extra_detail: str = None)

Bases: IntegrityError

exception MultipleObjectsReturned(extra_detail: str = None)

Bases: MultipleObjectsReturned

exception NotSaved(extra_detail: str = None)

Bases: NotSaved

exclude_from_toc = None

report_type: str = 'Layout:pptxslide'

Canonical type string used for subclass dispatch and filtering.

source_slide = None