Displaying
dimstack.display
mode(dispmode)
Set the display mode for the stack.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mode |
str
|
"text"/"txt", "str"/"string", "plot", "rich", or "df" |
required |
display_df(data, title='', dispmode=None)
Display a dataframe.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
df |
pd.DataFrame
|
description |
required |
dimstack.plot
StackPlot
Plot a stack of dimensions. This is a wrapper around Plotly.
show()
Show the plot. This works in both Jupyter notebooks and in a Python script.
add_dimension(item, start_pos=0)
Add a dimension to the plot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
item |
Union[Basic, Statistical]
|
description |
required |
start_pos |
int
|
description. Defaults to 0. |
0
|
add_stack(stack)
Add a stack of dimensions to the plot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
stack |
Stack
|
description |
required |
Returns:
| Name | Type | Description |
|---|---|---|
_type_ | description |
add(item)
Add a dimension or stack to the plot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
item |
Stack, Basic, Statistical
|
description |
required |
Raises:
| Type | Description |
|---|---|
TypeError
|
If the item is not a Stack, Basic, or Statistical. |
Returns:
| Name | Type | Description |
|---|---|---|
StackPlot | self |