Tree#

class ansys.dynamicreporting.core.serverless.item.Tree(*args, **kwargs)#

Bases: SimplePayloadMixin, Item

Item representing a hierarchical tree payload.

Methods

`Tree.add_tag`(tag[, value])	Add or update a single tag.
`Tree.as_dict`([recursive])	Serialize the model into a plain dictionary.
`Tree.create`(**kwargs)	Factory-style creation that dispatches to the correct subclass.
`Tree.delete`()	Delete this object from the database.
`Tree.filter`(**kwargs)	Return a collection of items, scoped by subclass type.
`Tree.find`([query])	Search for items using an ADR query string.
`Tree.get`(**kwargs)	Retrieve a single item instance, scoped by subclass type.
`Tree.get_tags`()	Return the raw tag string stored on this object.
`Tree.reinit`()	Reset the in-memory ORM state for this object.
`Tree.rem_tag`(tag)	Remove a tag by key, if it exists.
`Tree.remove_tag`(tag)	Alias for `rem_tag()` for backwards compatibility.
`Tree.render`(*[, context, request])	Render the item as HTML.
`Tree.save`(**kwargs)	Serialize the current content into the ORM `payloaddata` field.
`Tree.set_tags`(tag_str)	Replace all tags with the given tag string.

Attributes

`Tree.content`	Validated tree structure content for this item.
`Tree.dataset`	Dataset associated with this item.
`Tree.db`	Database alias in which this object is stored.
`Tree.name`	Human-readable name for the item.
`Tree.saved`	Whether this object has been successfully saved to the database.
`Tree.sequence`	Sequence index for ordering items within a dataset/session.
`Tree.session`	Session that owns this item.
`Tree.source`	Optional free-form source identifier for this item.
`Tree.tags`	Tag string used to group and filter objects.
`Tree.type`	Item type identifier for tree items.
`Tree.date`	Timestamp when the item was created.
`Tree.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

content: TreeContent = None#: Validated tree structure content for this item.

type: str = 'tree'#: Item type identifier for tree items.