Table

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

Bases: Item

Item representing a 2D table backed by a NumPy array.

The array is stored in the ORM payloaddata field together with additional payload properties such as row and column labels.

Methods

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

Attributes

Table.align_column
Table.bar_gap
Table.bar_mode
Table.col_tags
Table.collbls
Table.column_maximum
Table.column_minimum
Table.content	Validated 2D NumPy array content for this table item.
Table.dataset	Dataset associated with this item.
Table.db	Database alias in which this object is stored.
Table.format
Table.format_column
Table.format_row
Table.height
Table.histogram_bin_size
Table.histogram_cumulative
Table.histogram_normalized
Table.histogram_threshold
Table.item_justification
Table.labels_column
Table.labels_row
Table.legend_position
Table.line_color
Table.line_error_bars
Table.line_marker
Table.line_marker_aux0
Table.line_marker_aux1
Table.line_marker_aux2
Table.line_marker_aux3
Table.line_marker_aux4
Table.line_marker_aux5
Table.line_marker_aux6
Table.line_marker_aux7
Table.line_marker_aux8
Table.line_marker_aux9
Table.line_marker_opacity
Table.line_marker_scale
Table.line_marker_size
Table.line_marker_text
Table.line_style
Table.line_width
Table.marker_text_rowname
Table.name	Human-readable name for the item.
Table.nan_display
Table.palette
Table.palette_position
Table.palette_range
Table.palette_show
Table.palette_title
Table.plot
Table.plot_margins
Table.plot_title
Table.plot_xaxis_type
Table.plot_yaxis_type
Table.plot_zaxis_type
Table.row_tags
Table.rowlbls
Table.saved	Whether this object has been successfully saved to the database.
Table.sequence	Sequence index for ordering items within a dataset/session.
Table.session	Session that owns this item.
Table.show_border
Table.show_legend
Table.show_legend_border
Table.source	Optional free-form source identifier for this item.
Table.stacked
Table.table_bordered
Table.table_cond_format
Table.table_condensed
Table.table_default_col_labels
Table.table_page
Table.table_pagemenu
Table.table_scrollx
Table.table_scrolly
Table.table_search
Table.table_sort
Table.table_title
Table.table_wrap_content
Table.tags	Tag string used to group and filter objects.
Table.title
Table.type	Item type identifier for table items.
Table.width
Table.xaxis
Table.xaxis_format
Table.xaxis_tick_delta
Table.xrange
Table.xtitle
Table.yaxis
Table.yaxis_format
Table.yaxis_tick_delta
Table.yrange
Table.ytitle
Table.zaxis
Table.zaxis_format
Table.zaxis_tick_delta
Table.zrange
Table.ztitle
Table.date	Timestamp when the item was created.
Table.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

align_column = None

bar_gap = None

bar_mode = None

col_tags = None

collbls = None

column_maximum = None

column_minimum = None

content: TableContent = None

Validated 2D NumPy array content for this table item.

format = None

format_column = None

format_row = None

height = None

histogram_bin_size = None

histogram_cumulative = None

histogram_normalized = None

histogram_threshold = None

item_justification = None

labels_column = None

labels_row = None

legend_position = None

line_color = None

line_error_bars = None

line_marker = None

line_marker_aux0 = None

line_marker_aux1 = None

line_marker_aux2 = None

line_marker_aux3 = None

line_marker_aux4 = None

line_marker_aux5 = None

line_marker_aux6 = None

line_marker_aux7 = None

line_marker_aux8 = None

line_marker_aux9 = None

line_marker_opacity = None

line_marker_scale = None

line_marker_size = None

line_marker_text = None

line_style = None

line_width = None

marker_text_rowname = None

nan_display = None

palette = None

palette_position = None

palette_range = None

palette_show = None

palette_title = None

plot = None

plot_margins = None

plot_title = None

plot_xaxis_type = None

plot_yaxis_type = None

plot_zaxis_type = None

row_tags = None

rowlbls = None

save(**kwargs)

Serialize the table array and payload properties into payloaddata.

Parameters:

**kwargs

Keyword arguments forwarded to the database save method of the underlying ORM instance. For eg: The using argument can be used to select the target database alias.

Raises:

IntegrityError

If the database reports an integrity violation while saving.

InvalidFieldError

If invalid field names or values are supplied (via decorator).

Exception

Any other unexpected exception is propagated unchanged.

show_border = None

show_legend = None

show_legend_border = None

stacked = None

table_bordered = None

table_cond_format = None

table_condensed = None

table_default_col_labels = None

table_page = None

table_pagemenu = None

table_scrollx = None

table_scrolly = None

table_search = None

table_sort = None

table_title = None

table_wrap_content = None

title = None

type: str = 'table'

Item type identifier for table items.

width = None

xaxis = None

xaxis_format = None

xaxis_tick_delta = None

xrange = None

xtitle = None

yaxis = None

yaxis_format = None

yaxis_tick_delta = None

yrange = None

ytitle = None

zaxis = None

zaxis_format = None

zaxis_tick_delta = None

zrange = None

ztitle = None