Displaying

dimstack.display

mode(dispmode)

Set the display mode for the stack.

Parameters:
  • mode (str) –

    "text"/"txt", "str"/"string", "html", "rich", "notebook", or "df"

display_df(data, title='', dispmode=None)

Display a dataframe.

Parameters:
  • df (DataFrame) –

    description

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 scripts.

add_dimension(item, title=None, start_pos=None, color=None)

Add a dimension to the plot.

Parameters:
  • item (Basic) –

    description

  • title (str, default: None ) –

    description
add_distribution(distribution, name, start, stop, xbins_size=0.1, start_pos=None, color=None)

Add a distribution to the plot.

Parameters:
Returns:
  • _type_ –

    description
add_stack(stack)

Add a stack of dimensions to the plot.

Parameters:
  • stack (Stack) –

    description
Returns:
  • _type_ –

    description
add_reviewed_stack(stack)

Add a stack of reviewed dimensions to the plot.

Parameters:
  • stack (ReviewedStack) –

    description
Returns:
  • StackPlot –

    self
add(item)

Add a dimension or stack to the plot.

Parameters:
  • item (Basic | Reviewed | BasicStack | ReviewedStack) –

    description
Raises:
  • TypeError –

    If the item is not a Basic, Reviewed, BasicStack, or ReviewedStack
Returns:
  • StackPlot –

    self