Skip to main content

Screener Widget

This is the React component for the Screener Widget

Example#

import { Screener } from "react-ts-tradingview-widgets";
<Screener colorTheme="dark" width="100%" height={300}></Screener>

Used Private types#

TypeValue
DefaultColumnForexOrCryptooverview / performance / oscillators / moving_averages
DefaultColumnCountriesoverview / performance / valuation / dividends / margins / income_statement / balance_sheet / oscillators / moving_averages
DefaultScreenForexOrCryptogeneral / top_gainers / top_losers / ath / atl / above_52wk_high / below_52wk_low / monthly_high / monthly_low / most_volatile / overbought / oversold / outperforming_SMA50 / underperforming_SMA50
DefaultScreenCountriesmost_capitalized / volume_leaders / top_gainers / top_losers / ath / atl / high_dividend / above_52wk_high / below_52wk_low / most_volatile / unusual_volume / overbought / oversold / outperforming_SMA50 / underperforming_SMA50 / earnings_this_week
MarketCountriesamerica / australia / canada / egypt / germany / india / israel / italy / luxembourg / poland / sweden / turkey / uk / vietnam
MarketForexOrCryptoforex / crypto

Used Public types#

TypeValue
ColorThemelight / dark

Properties#

The defaultColumn and defaultScreen properties are different based on the choice of market. So if the market is one of MarketCountries, the choices for defaultColumn and defaultScreen are DefaultColumnCountries and DefaultScreenCountries. The same applies to MarketForexOrCrypto.

PropertyTypeRequiredDefaultDescription
widthnumber/stringfalse1100Sets a static width on the component
heightnumber/stringfalse512Sets a static height on the component
autosizebooleanfalsefalseSets the width and height to 100%
marketMarketCountries or MarketForexOrCryptofalseforexSets default exchange
defaultColumnDefaultColumnCountries or DefaultColumnForexOrCryptofalseoverviewSets default columns
defaultScreenDefaultScreenCountries or DefaultScreenForexOrCryptofalsegeneralSets default screens
showToolbarbooleanfalsetrueSets default Show top toolbar
colorThemeColorThemefalselightSets the default theme
localeLocalesfalseenSets the default locale
isTransparentbooleanfalsefalseTransparent background for component
largeChartUrlstringfalseundefinedMake widget redirect to larger chart