Skip to main content

OrderBookProps

Stock Screening Platform - Frontend API v0.1.0


Stock Screening Platform - Frontend API / components/stock/OrderBook / OrderBookProps

Interface: OrderBookProps

Defined in: src/components/stock/OrderBook.tsx:25

OrderBook Component Props

Properties

data

data: OrderBookData | null

Defined in: src/components/stock/OrderBook.tsx:27

Order book data


imbalance

imbalance: OrderImbalance | null

Defined in: src/components/stock/OrderBook.tsx:29

Order imbalance indicator


isLoading?

optional isLoading: boolean

Defined in: src/components/stock/OrderBook.tsx:31

Loading state


frozen?

optional frozen: boolean

Defined in: src/components/stock/OrderBook.tsx:33

Frozen state (no updates)


onToggleFreeze()?

optional onToggleFreeze: () => void

Defined in: src/components/stock/OrderBook.tsx:35

Freeze toggle callback

Returns

void


levels?

optional levels: number

Defined in: src/components/stock/OrderBook.tsx:37

Number of levels to display (default: 10)


detailed?

optional detailed: boolean

Defined in: src/components/stock/OrderBook.tsx:39

Show detailed view


mobile?

optional mobile: boolean

Defined in: src/components/stock/OrderBook.tsx:41

Mobile view