Cash Bids Table Widget

Tabular display of cash bids data with the ability to connect to the cash bids charting widgets.

Installation

script

Example

                              window.dtn.cashBids.createCashBidsTableWidget({
 


                                
});

Types

SiteId

type SiteId = string;

This type describe site id data that may be used to supply the siteId property.

CashBidId

type CashBidId = number;

This type describe cash bid id that may be used to supply the cashBidId property.

PortalCashBid

type PortalCashBid = { siteId: SiteId, cashBidId: CashBidId }

This type describe portal cash bid object, containing siteId and cashBidId.

Configuration

apiKey

apiKey: string;

The widget access api key associated with your DTN account.

container

container: HTMLElement | string;

The container to mount the widget on. This can be a reference to an HTML element, or a valid selector string. If a string is encountered, document.querySelector will be used to search document for the container.

siteId

siteId: SiteId;

The Site Identifier used when setting up the account in Portal Publisher.

Callbacks

onCashBidSelect

onCashBidSelect: (cashBid: PortalCashBid) => void;

This callback will be called whenever the chart symbol on a cash bids table is clicked.

Composable Widgets