Heatmap
Compare market or portfolio listings in a color-coded heatmap.
Overview
| Property | Value |
|---|---|
| Key | heatmap |
| Category | Trading |
The Heatmap widget is a read-only view of listings sized and colored from current market or portfolio data.
Features
- Two sources --
sourceModeselectswatchlistorportfoliodata and defaults towatchlist. - Workspace watchlists -- Watchlist mode automatically combines listings from every watchlist in the active workspace and deduplicates listings shared by more than one watchlist.
- Watchlist sizing --
watchlistSizeMetricdefaults tovolumeUsdfor USD turnover; selectvolumefor unit volume. - Portfolio context -- Portfolio mode reads the selected broker account through
tradingProvider,serviceId, andportfolioIdentity. - Linked selection -- Selecting a tile updates the linked
listingfor widgets with the same pair color. - Refresh -- Updating
runtime.refreshAtrequests fresh data without changing saved settings.
Usage
Choose the market provider and its parameters or credentials. By default, Watchlist mode uses the deduplicated listings from all workspace watchlists and sizes them by volumeUsd; manage those listings in the Watchlist widget, or switch sizing to volume. The heatmap renders up to 200 listings and reports when additional listings are omitted.
In Portfolio mode, select a broker and broker account so portfolioIdentity identifies the holdings. Click a tile to publish its listing to linked widgets. The heatmap does not place or modify orders.
Portfolio mode requires a configured broker account; quote enrichment can still depend on the selected market provider.
Configuration
| Parameter | Description |
|---|---|
listing | Listing currently shared with linked widgets. |
sourceMode | watchlist (default) or portfolio. |
watchlistSizeMetric | volumeUsd (default) or volume in Watchlist mode. |
marketProvider | Provider used for listing and quote data. |
marketProviderParams | Provider-specific market parameters. |
marketAuth | Optional market-provider credentials. |
tradingProvider | Broker provider used in Portfolio mode. |
serviceId | Broker service identifier. |
portfolioIdentity | Canonical selected broker-account identity. |
runtime.refreshAt | Timestamp used to request refresh. |