TradingView--Widget构造器

赏阳嘉

2023-12-01

当调用构造函数时，您可以定义图表库 widget 的参数。例：

new TradingView.widget({
    symbol: 'A', 
    interval: 'D', 
    timezone: "America/New_York", 
    container_id: "tv_chart_container", 
    locale: "ru", 
    datafeed: new Datafeeds.UDFCompatibleDatafeed("https://demo_feed.tradingview.com") 
});

重点：在图表初始化后在更改这些参数是不起作用的。如果要在初始化图表之后更改图表的状态，请使用widget方法。

symbol：初始商品。

interval：图表的和间隔。

locale：语言（如果用中文，'zh'）。

timeframe：设置图表的初始时间范围。时间范围是加载并显示在屏幕上的K 线范围。有效的时间范围是一个数字加一个字母，D 为数天， M 为数月。

container_id ：id 属性为指定要包含 widget 的 DOM 元素 id 。必须项

datafeed：JavaScript对象的实现接口JSAPI 以反馈图表及数据。必须项

timezone：图表的初始时区。时间刻度上的数字取决于这个时区。

debug：将此属性设置为 true 时，可使图表将详细的 API 日志写入控制台。

library_path：static 文件夹的路径（重点，有好多刚开始都会忽略这一点，如果是VUE项目，路径必须为跟目录static文件夹或public文件夹）

width,height:widget的尺寸，请确保 widget 拥有足够的空间。

Remark : 如果您想让图表占据所有可用的空间，请不要使用 '100%' 这样的字段。使用 fullscreen 参数来代替。这是因为 DOM 节点在不同浏览器中有调整大小的问题。

fullscreen:默认值: false 布尔值显示图表是否占用窗口中所有可用的空间。

autosize:默认值: false 布尔值，显示图表是否应使用容器中的所有可用空间，并在调整容器本身大小时自动调整大小。

symbol_search_request_delay：延迟阈值（以毫秒为单位），用于在用户在搜索框中键入商品名称时减少商品搜索请求的数量。

auto_save_delay：延迟秒数等待 onAutoSaveNeeded 可以被再次调用。

toolbar_bg：工具栏背景颜色

study_count_limi：多图布局图表的最大指标数量。最小值为2 。

studies_access ：具有以下结构的对象：

{ 
    type: "black" | "white", 
    tools: [ 
                { 
                    name: "<study name>", 
                    grayed: true 
                },
                < ... > 
            ] 
}
//type 是列表类型。 支持的值: black (所有列出的项目会被禁用), white (只有列出的项目 会被启用)。

//tools 对象数组。每个对象可以具有以下属性：
    //name (强制的) 指标的名称。使用相同的名称，你可以看到他们在指标控件。 
    //grayed 布尔值，表明这项指标将可见，但看起来像是被禁用的。 如果指标 为 grayed ，当用户点击它时，会调用 onGrayedObjectClicked 回调方法。

Remark： 基于字体的绘图有一个特殊情况。使用 Font Icons 的名字时，这个组是一个特例，它的绘图不能被启用或禁用 - 可以启用或禁用整个组。

saved_data：JS对象包含保存的图表内容（JSON ）。如果在创建图表时已经有图表的JSON ，请使用此参数。如果要将图表内容加载到已初始化的图表中，请使用 loadData() 控件方法。

local：图表库的本地化处理。

numeric_formatting ：该对象包含数字的格式化选项。目前唯一可能的选择是 decimal_sign 。例: numeric_formatting: { decimal_sign: "," }

customFormatters：

它是一个包含以下字段的对象：

1. timeFormatter

2. dateFormatter

您可以使用这些格式化方法自定义显示日期和时间的值。这两个值都是具有方法 format 和 formatLocal 的对象

function format(date) 
function formatLocal(date)

这些函数返回表示 date 或 time 的文本。 formatLocal 将日期和时间转换为本地时区。

例：

customFormatters: { 
    timeFormatter: { 
        format: function(date) {
             var _format_str = '%h:%m'; 
             return _format_str.replace('%h' , date.getUTCHours(), 2).replace('%m', date.getUTCMinutes(), 2). replace('%s', date.g etUTCSeconds(), 2);
        } 
    },
    dateFormatter: {
         format: function(date) { 
            return date.getUTCFullYear() + '/' + date.getUTCMonth() + '/' + date.getUTCDate(); 
        } 
    } 
}

overrides：对Widget 对象的默认属性进行覆盖。覆盖属性意味着为其分配默认值。您可以覆盖大部分图表的属性（也可以由用户通过UI 编辑）使用 overrides 参数构造控件。 overrides 应该是一个具有范围的对象。每个字段名是重写属性的名称，字段值是这些属性的期望值。例子:

overrides: { 
    "symbolWatermarkProperties.color": "rgba(0, 0, 0, 0)" 
}

这个 override 将使水印 100％不透明（不可见）。

disabled_features, enabled_features：包含功能在默认情况下启用/禁用名称的数组。功能表示图表功能的一部分（更是UI/UX的一部分）。

snapshot_url：当用户按快照按钮时,使用base64编码将当前图表快照保存并返回URL。该服务返回完整的保存图像URL。

indicators_file_name：包含您编写的指标的文件路径。

preset：preset 是一组预定义窗口小部件设置的名称。预设中使用的所有设置也可以直接在窗口小部件的构造函数中使用。现在只支持 mobile 预设。此预设的示例可在线获取。

studies_overrides:使用此选项自定义默认指标的样式及输入值。您还可以使用此参数自定义 Compare 系列的样式和输入值。

time_frames:在图表底部的时间范围选择器中可以看见这个时间范围列表。

charts_storage_api_version:您的后台版本。支持的值: "1.0" | "1.1" 。指标模板从 1.1 开始得到支持。

load_last_chart：将此参数设置为 true 如果您希望库加载用户的最后一张图表（您也应该具有

[save/load|Saving-and-Loading-Charts] ）。

custom_css_url (since 1.4)：将您的自定义CSS 添加到图表中。 url 应该是到 'static` 文件夹的绝对或相对路径。

loading_screen (since 1.12)：定制加载进度条。值是具有以下可能 key 的对象。

backgroundColor

foregroundColor

Example:

loading_screen : { backgroundColor : "#000000" }

favorites：默认支持该项目。此选项需要禁用localstorage的使用。 favorites property 为一个对象，拥有以下属性：

intervals(间隔 ) : 收藏的间隔数组。

例： ["D", "2D"]

chartTypes(图表类型 ) : 收藏的图表类型数组。图表类型名称与图表的 UI 中的英文版本相

同。

例: ["Area", "Candles"]

TradingView--Widget构造器

相关阅读

相关文章

相关问答

相关文档