npm包 react-tradingview-wrapper 使用教程

在前端开发中,React是非常流行的JavaScript库,而TradingView则是一个知名的金融数据可视化工具。 现在,通过npm包react-tradingview-wrapper,我们可以将这两者结合起来,更加轻松地将TradingView集成到React项目中。

什么是react-tradingview-wrapper ?

react-tradingview-wrapper是一个使用React编写的npm包,它封装了TradingView的官方API,使得开发者可以更加容易地在React中使用TradingView。

具体来说,react-tradingview-wrapper为开发者提供了一个TradingView组件,该组件包含了几乎所有的TradingView配置和功能。开发者只需要将该组件包含到他们的React代码中即可。

安装

要安装react-tradingview-wrapper,需要在命令行中输入以下命令:

--- ------- -------------------------

安装完成后,你就可以在你的项目中引入此npm包。

使用

在你的React代码中,你可以按以下方式使用react-tradingview-wrapper组件:

------ ------------------ - ------ - ---- ----------------------------

----- --- - -- -- -
  ------ -
    -----
      ------------------
        ---------------
        -------------------
        --------
      --
    ------
  --
--

如上所述,我们首先通过import语句引入了我们需要的TradingViewWidget组件。然后,我们在我们的组件层次结构中包含了一个TradingViewWidget组件。

当传递给TradingViewWidget的属性改变时,TradingViewWidget会自动更新显示的数据。出于实现和性能方面的原因,通过此组件属性更新数据时不会重绘整个图表。

组件属性

TradingViewWidget中可以传入的属性非常多,但以下是一些最为常用的属性:

symbol

  • type: string
  • default: 'BTCUSD'

TradingView中的symbol(交易对)。此属性必须是合法的TradingView symbol编号(例如,AAPL或者XAGUSD)。

theme

  • type: string
  • default: Themes.DARK

TradingView的主题。此属性必须是TradingView主题之一的字符串。可选值有Themes.DARKThemes.LIGHTThemes.CHARTIQThemes.BLACK。每个主题都在react-tradingview-wrapper的源代码中有定义。

autosize

  • type: boolean
  • default: false

指定TradingView是否应该自动调整以适应其被包含在的DOM元素。如果为true,TradingView将扩展到其包含DOM元素的大小。要启用自适应大小,请确保为TradingViewWidget的直接父元素设置了有效的高度和宽度。

interval

  • type: string
  • default: 'D'

TradingView图表的时间间隔。请参阅TadingView时间间隔文档以获取可用选项。

timeframe

  • type: string
  • default: '1D'

TradingView图表的时间跨度。请参阅TadingView时间跨度文档以获取可用选项。

toolbar_bg

  • type: string
  • default: '#f1f3f6'

TradingView图表工具栏的背景颜色。

事件回调

除了属性之外,TradingViewWidget还支持事件回调。这些回调函数将在特定事件中执行。以下是一些常见的回调函数:

onWidgetReady

此回调函数在TradingView图表初始化后执行。

onSymbolChange

当用户更改了当前的TradingView symbol时运行此函数。

onIntervalChange

当用户更改了TradingView时间间隔时运行此函数。

onTimeframeChange

当用户更改了TradingView时间跨度时运行此函数。

onChartReady

当TradingView图表准备就绪并可用于处理的所有数据时,执行此函数。

------ ------------------ - ------ - ---- ----------------------------

----- --- - -- -- -

  ----- ---------------- - -- -- -
    ----- ------- - ---------------------------------------------------- -- -------------------
    ---------------------------- ----------------- ------
  --

  ------ -
    -----
      ------------------
        ---------------
        -------------------
        --------
        -------------------------------
      --
    ------
  --
--

在此示例中,我们定义了一个名为handleChartReady的函数。每当TradingView图表准备好能够处理的所有数据时,这个函数就会运行。在这个函数中,我们使用了窗口内部tvWidget对象的“getAllSeries”方法来获取TradingView中当前正在显示的交易对。

总结

通过npm包react-tradingview-wrapper,我们可以轻松地将TradingView集成到React项目中。此组件提供了各种配置和事件回调,以使开发者可以控制其显示和操作。

在本文中,我们介绍了如何安装和使用react-tradingview-wrapper,特别是如何配置和使用其各种属性,以及如何通过其事件回调捕获各种事件。

希望此教程可以帮助React开发者更加轻松地使用TradingView,促进他们在开发金融可视化应用程序时的创新和成功。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005761781e8991b448ea8d7


猜你喜欢

  • npm 包 @matthieurambert/jqueryslide 使用教程

    前言 前端开发中,经常需要用到轮播图来增加页面的交互性和美观性。而 jQuery 是前端界最流行的 JavaScript 库之一,许多开发者也喜欢用它来完成自己的工作。

    3 年前
  • npm 包 is-gnome-session 使用教程

    在 Linux 系统中,GNOME 是一个常见的桌面环境。如果你想在你的应用程序中判断当前是否处于 GNOME 桌面环境下,就需要使用到 is-gnome-session 这个 npm 包。

    3 年前
  • npm 包 itp-bluetooth-template 使用教程

    简介 itp-bluetooth-template 是一个基于 JavaScript 实现的 npm 包,用于实现浏览器端与蓝牙设备之间的通信。itp-bluetooth-template 提供了一种...

    3 年前
  • NPM 包 easy-mediasoup-v1 使用教程

    简介 Mediasoup 是一个专为 WebRTC 而设计的基于 Node.js 的媒体服务器。其强大的功能和灵活的架构,使得 Mediasoup 成为开发 WebRTC 应用的最佳选择之一。

    3 年前
  • npm 包 @anycli/parser 使用教程

    在前端开发中,处理命令行参数是一项常见的任务。通常,我们需要编写大量的代码来解析和验证这些参数。但是,这项任务可以变得更简单和优雅,如果我们使用 @anycli/parser 这个 npm 包来处理命...

    3 年前
  • npm 包 @ndxbn/npm_prepbulish_migration_test 使用教程

    简介 在前端开发过程中,我们经常需要使用各种 npm 包。而本文介绍的 npm 包 @ndxbn/npm_prepbulish_migration_test 可以帮助我们更轻松地发布自己的 npm 包...

    3 年前
  • npm包:ngx-log-service使用教程

    前言 随着前端的发展,前端代码量越来越庞大,出现了很多需要管理和记录日志的情况。此时,命令行日志工具无法满足前端的这种需求。于是,解决前端日志记录的库就应运而生。本文将介绍一种称为ngx-log-se...

    3 年前
  • npm 包 siimact 使用教程

    简介 siimact 是一个基于 Vue.js 开发的 UI 框架,包含丰富的 UI 组件,使用简洁方便。它是一个开源的 npm 包,可以通过 npm 安装使用。 安装 使用 npm 安装 siima...

    3 年前
  • npm 包 stylus-grid 使用教程

    前言 在前端开发中,我们常常需要使用到栅格化布局。而 stylus-grid 就是一种比较常用的栅格化布局方案之一。本文将详细介绍如何使用 npm 包 stylus-grid 来实现栅格化布局。

    3 年前
  • npm 包 tiny-compress 使用教程

    在前端开发中,图像压缩是非常常见的一项技术。在这里,我们将介绍一个 npm 包——tiny-compress,它可以帮助您轻松地对图片进行压缩。 什么是 tiny-compress? tiny-com...

    3 年前
  • npm 包 zepto.timer-handler 使用教程

    前言 在前端开发中,我们经常需要处理一些时间相关的操作。开发者可以通过使用 Javascript 的 setTimeout 和 setInterval 方法来实现一些简单的定时器操作,但是这些方法并不...

    3 年前
  • npm 包 auth0-retrieve-user 使用教程

    前言 auth0-retrieve-user 是一个对于使用 auth0 身份认证系统的开发者来说非常有用的 npm 包。它可以帮助开发者在前端应用程序中获取 auth0 认证用户的信息,从而更方便地...

    3 年前
  • npm 包 bottender-azure-functions 使用教程

    在本篇文章中,我们将探讨如何使用 npm 包 bottender-azure-functions 将我们的 Bottender 机器人应用部署到 Azure Functions 上。

    3 年前
  • npm 包 @superdyzio/react-plotly.js 使用教程

    介绍 @superdyzio/react-plotly.js 是一个在 React 项目中使用 Plotly.js 的 npm 包。Plotly.js 是一个基于 JavaScript 的开源绘图库,...

    3 年前
  • Bottender-lambda 使用教程

    前言 Bottender-lambda 是一个基于 AWS Lambda 和 API Gateway 的 Serverless 聊天机器人框架。通过 Bottender-lambda,开发者可以快速地...

    3 年前
  • npm 包 cognitauth 使用教程

    简介 在前端开发中,我们经常需要使用用户认证和鉴权机制。AWS Cognito 是一个完全托管的身份验证、授权和用户管理服务,可以更轻松地添加用户身份验证和授权功能到 Web 和移动应用程序中。

    3 年前
  • npm 包 insomnia-plugin-randomkey 使用教程

    在前端开发中,常常需要生成随机字符串或数字用于生成唯一的 ID,加强密码安全等。手写随机字符串函数虽然不难,但是在各个项目中重复实现浪费时间,不如使用一个 npm 包。

    3 年前
  • npm 包 homebridge-sonoff-tasmota-http 使用教程

    简介 homebridge-sonoff-tasmota-http 是一款基于 Node.js 的 npm 包,用于快速搭建一个能够控制 Sonoff/Tasmota 设备的 HomeKit 桥接器。

    3 年前
  • npm 包: react-data-dam 使用教程

    简介 react-data-dam 是一款基于 React 的高性能数据管理工具, 可以快速地实现数据的增删改查,是开发 React 应用的好帮手。本文将介绍如何使用 react-data-dam 实...

    3 年前
  • npm 包 isccw 使用教程

    在前端开发中,经常需要使用到各种工具来提高效率和减少重复性工作。其中一个重要的工具就是 npm 包。npm 包是 JavaScript 语言的模块管理器,可以帮助开发者快速地安装、管理和分享代码。

    3 年前

相关推荐

    暂无文章