HeatMarkdownService

Portfolio Heatmap Markdown Service.

Subscribes to signalEmitter and aggregates statistics across all symbols per strategy. Provides portfolio-wide metrics and per-symbol breakdowns.

Features:

• Real-time aggregation of closed signals
• Per-symbol statistics (Total PNL, Sharpe Ratio, Max Drawdown, Trades)
• Portfolio-wide aggregated metrics per strategy
• Markdown table report generation
• Safe math (handles NaN/Infinity gracefully)
• Strategy-based navigation using memoized storage

Constructor

constructor();
Copy

Properties

loggerService

loggerService: any
Copy

Logger service for debug output

getStorage

getStorage: any
Copy

Memoized function to get or create HeatmapStorage for exchange, frame and backtest mode. Each exchangeName + frameName + backtest mode combination gets its own isolated heatmap storage instance.

subscribe

subscribe: (() => () => void) & ISingleshotClearable
Copy

Subscribes to signal emitter to receive tick events. Protected against multiple subscriptions. Returns an unsubscribe function to stop receiving events.

unsubscribe

unsubscribe: () => Promise<void>
Copy

Unsubscribes from signal emitter to stop receiving tick events. Calls the unsubscribe function returned by subscribe(). If not subscribed, does nothing.

tick

tick: any
Copy

Processes tick events and accumulates closed signals. Should be called from signal emitter subscription.

Only processes closed signals - opened signals are ignored.

getData

getData: (exchangeName: string, frameName: string, backtest: boolean) => Promise<HeatmapStatisticsModel>
Copy

Gets aggregated portfolio heatmap statistics.

getReport

getReport: (strategyName: string, exchangeName: string, frameName: string, backtest: boolean, columns?: Columns$3[]) => Promise<string>
Copy

Generates markdown report with portfolio heatmap table.

dump

dump: (strategyName: string, exchangeName: string, frameName: string, backtest: boolean, path?: string, columns?: Columns$3[]) => Promise<void>
Copy

Saves heatmap report to disk.

Creates directory if it doesn't exist. Default filename: {strategyName}.md

clear

clear: (payload?: { exchangeName: string; frameName: string; backtest: boolean; }) => Promise<void>
Copy

Clears accumulated heatmap data from storage. If payload is provided, clears only that exchangeName+frameName+backtest combination's data. If payload is omitted, clears all data.