Chartbreaker
    Preparing search index...

    Interface OrderList

    interface OrderList {
        destroy: () => any;
        getCursor: () => { hasMore: boolean; loadMorePrompt?: string };
        getRows: () => Order[];
        getSummary?: () => Order;
        loadNext: (opts?: { fromDate?: Date; limit?: number }) => Promise<void>;
        getModificationsObservable(): Observable<ListModification<Order>[]>;
        getNextReloadObservable(): Observable<void>;
        getRetryLoadObservable?(): Observable<void>;
        getWarningStatusObservable?(): Observable<TradeSummaryWarningStatus>;
    }
    Index

    Properties

    destroy getCursor getRows getSummary? loadNext

    Methods

    getModificationsObservable getNextReloadObservable getRetryLoadObservable? getWarningStatusObservable?

    Properties

    destroy: () => any
    getCursor: () => { hasMore: boolean; loadMorePrompt?: string }
    getRows: () => Order[]
    getSummary?: () => Order

    If getSummary is defined, it returns a summary object of the OrderList. Currently this is only available for the px trades (view history). The function should be called whenever rows are expected to have changed (i.e. when an ModificationsObservable emits). Note that this API is subject to change if the feature turns out useful for other views. Clients may ignore this row if a total/summary row is not needed to be displayed.

    loadNext: (opts?: { fromDate?: Date; limit?: number }) => Promise<void>

    Methods

    • Create an observable that will emit when the next reload of this list is complete. It will just emit (at max) one time and complete.

      Returns Observable<void>

    • If defined, clients can use this to get notified when a retry load makes sense. For example, data might not be ready at the broker initially. In this case, loadNext might fail. However the data may become available later. If the broker implementation can observe this, it will notify subscribers.

      Returns Observable<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods