display_positions#
API documentation for tradeexecutor.analysis.position.display_positions Python function.
- display_positions(positions, trade_type=None)[source]#
Format trading positions for Jupyter Notebook table output.
Display in one table
All positions
Their underlying trades (conditionally based on trade_type)
- Parameters:
positions (Iterable[TradingPosition]) – Positions to display
trade_type (tradeexecutor.cli.commands.shared_options.TradeType | None) – Controls whether trades are displayed. If None or TradeType.all, trades are shown. If TradeType.none, trades are hidden.
- Returns:
DataFrame containing positions and optionally trades, values as string formatted
- Return type:
DataFrame