Widget构造器


当调用构造函数时,您可以定义图表库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*

您的图表的初始商品和周期。interval的格式在另一篇文章中说明。 必须项

container_id*

id 是DOM元素的id属性,带有图表的iframe将放置在其中。

datafeed*

实现(JS API)接口以向图表提供数据的JavaScript对象。

timeframe

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

timezone

图表的初始时区。时间刻度上的数字取决于这个时区。请参阅支持的时区列表。设置为交易所时区。覆盖默认值,您应该使用覆盖章节

debug

将此属性设置为 true时,可使图表将详细的API日志写入控制台。与功能集的charting_library_debug_mode用法相同。

library_path

static文件夹的路径

width, height

widget的尺寸,请确保widget拥有足够的空间。

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

fullscreen

默认值: false

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

autosize

默认值: false

布尔值,显示图表是否应使用窗格中的所有可用空间,并在调整窗格本身大小时自动调整大小。

symbol_search_request_delay

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

auto_save_delay

延迟秒数等待 onAutoSaveNeeded 可以被再次调用。 该参数介绍在1.5版本中。

toolbar_bg

工具栏背景颜色

study_count_limit

自1.5版本起。

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

studies_access

版本:1.1具有以下结构的对象:

{
    type: "black" | "white",
    tools: [
        {
            name: "<study name>",
            grayed: true
        },
        < ... >
    ]
}
  • type是列表类型。 支持的值:black(所有列出的项目会被禁用),white(只有列出的项目会被启用)。
  • tools对象数组。每个对象可以具有以下属性:
    • name(强制的) 指标的名称。使用相同的名称,你可以看到他们在指标控件。
    • grayed布尔值,表明这项指标将可见,但看起来像是被禁用的。 如果指标为grayed,当用户点击它时,会调用onGrayedObjectClicked回调方法。

drawings_access

版本:1.1 该属性与上述的studies_access具有相同的结构。 使用与您在UI中看到的名称相同的名称。

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

saved_data

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

locale

图表库的本地化处理 。详情:本地化

numeric_formatting

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

customFormatters

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

  1. timeFormatter
  2. dateFormatter

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

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.getUTCSeconds(), 2); }
  },
  dateFormatter: {
    format: function(date) { return date.getUTCFullYear() + '/' + date.getUTCMonth() + '/' + date.getUTCDate(); }
  }
}

overrides

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

overrides: {
    "mainSeriesProperties.style": 0
}

这个 override将使水印100%不透明(不可见)。 所有可定制的属性都列在单独的文章中。 从1.5开始,您可以使用绘图覆盖。绘图覆盖.

disabled_features, enabled_features

包含功能在默认情况下启用/禁用名称的数组。功能表示图表功能的一部分(更是UI/UX的一部分)。 这里. 此处列出了支持的功能。 例:

TradingView.onready(function()
{
    var widget = new TradingView.widget({
        /* .... */
        disabled_features: ["header_widget", "left_toolbar"],
        enabled_features: ["move_logo_to_main_pane"]
    });
});

snapshot_url

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

custom_indicators_getter

返回带有自定义指标数组的Promise对象的函数。 PineJS 变量将作为此函数的第一个参数传递,并可在指标内用于访问内部帮助函数。 查看更多细节

preset

preset是一组预定义widget设置的名称。现在预设中只支持mobile。此预设的示例可在线获取

studies_overrides

使用此选项自定义默认指标的样式及输入值。 您还可以使用此参数自定义Compare数据列的样式和输入值。 查看更多

time_frames

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

time_frames: [
    { text: "50y", resolution: "6M", description: "50 Years" },
    { text: "3y", resolution: "W", description: "3 Years", title: "3yr" },
    { text: "8m", resolution: "D", description: "8 Month" },
    { text: "3d", resolution: "5", description: "3 Days" },
    { text: "1000y", resolution: "W", description: "All", title: "All" },
]

time_frames是一个包含textresolution属性的对象。 text属性应具有以下格式:<integer> <y | m | d>( \d+(y|m|d) 为正则表达式 )。 resolution是一个字符串,格式说明

属性 description 在v1.7开始支持,显示在弹出菜单中。 此参数是可选的。如果未指定,则使用titletext属性作为描述。

属性 title 在v1.9开始支持,其值将覆盖基于text属性生成的默认标题。 此参数是可选的。

charts_storage_url, client_id, user_id

这些参数与用于保存/加载的高级API相关。 查看更多细节.

charts_storage_api_version

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

load_last_chart

如果您希望图表库为用户加载上次保存的图表,请将此参数设置为 true (您应首先实现save/load以使其工作)。

theme

从1.13版开始支持。

为图表添加自定义主题颜色。 支持的值是: "Light" | "Dark".

custom_css_url

从1.4版开始支持。

将您的自定义CSS添加到图表中。url应该是到static文件夹的绝对或相对路径。

loading_screen

从1.12版开始支持。

定制加载进度条。值是具有以下可能 key 的对象。

  • backgroundColor
  • foregroundColor

例如:

loading_screen: { backgroundColor: "#000000" }

favorites

默认标记为收藏的项目。此选项使用时要求禁用localstorage(请参阅功能集以了解更多)。favorites 属性为一个对象,拥有以下属性:

  • intervals(周期): 收藏的周期数组。 例:["D", "2D"]
  • chartTypes(图表类型): 收藏的图表类型数组 。图表类型名称与图表的UI中的英文版本相同。 例:["Area", "Candles"]

save_load_adapter

从1.12版开始支持。

包含保存/加载功能的对象。 如果设置了,应有以下方法:

Chart layouts

  1. getAllCharts(): Promise<ChartMetaInfo[]>

    获取所有保存的图表。

    ChartMetaInfo 具有以下字段的对象:

    • id - 图表id
    • name - 图表名
    • symbol - 图表的商品
    • resolution - 周期
    • timestamp - 最后修改日期(从 01/01/1970 0时开始的毫秒单位UTC时间)。
  2. removeChart(chartId): Promise<void>

    删除图表。 chartId是图表的唯一ID(参见上面的getAllCharts)。

  3. saveChart(chartData: ChartData): Promise<ChartId>

    存储图表。

    ChartData 具有以下字段的对象:

    • id - 图表的唯一标识(如果未保存则可能是undefined)。
    • name - 图表名
    • symbol - 图表的商品
    • resolution - 周期
    • content - 图表的内容

    ChartId - 图表唯一id (string)

  4. getChartContent(chartId): Promise<ChartContent>

    通过服务器加载图表

    ChartContent 带有图表内容的字符串(参见saveChart函数中的ChartData::content字段)。

Study Templates

  1. getAllStudyTemplates(): Promise<StudyTemplateMetaInfo[]>

    获取所有保存的指标模板。

    StudyTemplateMetaInfo 具有以下字段的对象:

    • name - 指标模板名称
  2. removeStudyTemplate(studyTemplateInfo: StudyTemplateMetaInfo): Promise<void>

    删除指标模板

  3. saveStudyTemplate(studyTemplateData: StudyTemplateData): Promise<void>

    存储指标模板

    StudyTemplateData 具有以下字段的对象:

    • name - 指标模板名称
    • content - 指标模板的内容
  4. getStudyTemplateContent(studyTemplateInfo: StudyTemplateMetaInfo): Promise<StudyTemplateContent>

    通过服务器加载指标模板

    StudyTemplateContent - 指标模板的内容 (string)

    如果同时设置了 charts_storage_urlsave_load_adapter, 将使用 save_load_adapter

    重要: 所有函数都会返回Promise(或Promise类对象)。

settings_adapter

从1.11版开始支持。

包含设置/删除方法的对象。 使用它将图表设置保存到您想要存储的地方,包括服务器端。 如果设置了,应该有以下方法:

  1. initialSettings: Object 初始化设置

  2. setValue(key: string, value: string): void 存储键/值对

  3. removeValue(key: string): void 删除键

交易终端专属

widgetbar

仅适用于交易终端

含图表右侧窗口小部件面板设置的对象。可以使用Widget构造函数中的“widgetbar”字段启用图表右侧的监视列表,新闻和详细信息窗口小部件:

widgetbar: {
    details: true,
    watchlist: true,
    watchlist_settings: {
        default_symbols: ["NYSE:AA", "NYSE:AAL", "NASDAQ:AAPL"],
        readonly: false
    }
}
  • details (default: false): 在右侧的小部件面板中启用详细信息小部件。
  • watchlist (default: false): 在右侧的小部件面板中启用观察列表小部件。
  • watchlist_settings.default_symbols (default: []): 设置监视列表的默认商品列表。
  • watchlist_settings.readonly (default: false): 为监视列表启用只读模式。

rss_news_feed

仅适用于交易终端

使用此属性更改新闻的RSS源。 您可以为每个商品类型设置不同的RSS。或为所以商品使用同一个RSS。该对象将拥有default属性,其他属性是可选的; 属性的名称与商品类型匹配。每个属性都是具有以下属性的对象(或对象数组):

  1. url请求的URL。 它可以包含以下花括号中的标签(将会被终端所更改): {SYMBOL},{TYPE},{EXCHANGE}。
  2. name 要在新闻下面显示的Feed名称。

例:

{
    "default": [ {
        url: "https://articlefeeds.nasdaq.com/nasdaq/symbols?symbol={SYMBOL}",
        name: "NASDAQ"
      }, {
        url: "http://feeds.finance.yahoo.com/rss/2.0/headline?s={SYMBOL}&region=US&lang=en-US",
        name: "Yahoo Finance"
      } ]
}

另一个例子:

{
    "default": {
        url: "https://articlefeeds.nasdaq.com/nasdaq/symbols?symbol={SYMBOL}",
        name: "NASDAQ"
    }
}

更多例子:

{
    "default": {
        url: "https://articlefeeds.nasdaq.com/nasdaq/symbols?symbol={SYMBOL}",
        name: "NASDAQ"
     },
    "stock": {
        url: "http://feeds.finance.yahoo.com/rss/2.0/headline?s={SYMBOL}&region=US&lang=en-US",
        name: "Yahoo Finance"
    }
}

news_provider

仅适用于交易终端

指定新闻提供者的对象。 它可能包含以下属性:

  1. is_news_generic- 如果为true, 则新闻小部件的标题将不包含商品名称(仅包含“标题”)。 否则将添加for SYMBOL_NAME

  2. get_news- 使用此属性设置自己的新闻getter方法。 symbolcallback都将传递给函数。

    回调函数被调用时,会传递以下结构的新闻对象:

    1. title(必须) - 新闻标题。
    2. published(必须) - 新闻时间(以毫秒为单位的UTC时间)
    3. source(可选) - 标题的新闻来源。
    4. shortDescription(可选) - 将在标题下显示的新闻项目的简短描述。
    5. link(可选) - 新闻报道的URL
    6. fullDescription(可选) - 新闻项目的完整描述(正文)

    注意:当用户点击新闻项目时,将打开带有linkURL的新标签页。 如果没有指定link,将显示带有fullDescription的对话框弹出窗口。

    注意2:如果news_providerrss_news_feed都可用,那么rss_news_feed将被忽略。

例:

news_provider: {
    is_news_generic: true,
    get_news: function(symbol, callback) {
        callback([
            {
                title: 'News for symbol ' + symbol,
                shortDescription: 'Short description of the news item',
                fullDescription: 'Full description of the news item',
                published: new Date().valueOf(),
                source: 'My own source of news',
                link: 'https://www.tradingview.com/'
            },
            {
                title: 'Another news for symbol ' + symbol,
                shortDescription: 'Short description of the news item',
                fullDescription: 'Full description of the news item. Long text here.',
                published: new Date().valueOf(),
                source: 'My own source of news',
            }
        ]);
    }
}

brokerFactory

仅适用于交易终端

使用这个字段来传递构造经纪商API的实现类。 这是一个接收交易主机并返回经纪商API的方法。

brokerConfig

仅适用于交易终端

brokerConfig: { configFlags: {...} } 使用此字段设置交易终端的配置标志。 了解更多

也可以看看

results matching ""

    No results matching ""