UserDefinedLayout

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

Bases: Layout

Layout whose behavior is delegated to user-defined logic.

Methods

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

Attributes

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

before_children = None

interactive_only = None

report_type: str = 'Layout:userdefined'

Canonical type string used for subclass dispatch and filtering.

userdef_name = None