shen/lightweight-charts
1
0
Fork 0
mirror of https://github.com/tradingview/lightweight-charts.git synced 2024-11-25 16:50:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme.md to include mention of attributionLogo option

Browse Source
This commit is contained in:
Mark Silverwood 2024-03-11 14:26:15 +01:00
parent 7ff6ba91e7
commit bea721abde
No known key found for this signature in database
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -103,6 +103,7 @@ This software incorporates several parts of tslib (<https://github.com/Microsoft
This license requires specifying TradingView as the product creator.
You shall add the "attribution notice" from the NOTICE file and a link to <https://www.tradingview.com/> to the page of your website or mobile application that is available to your users.
As thanks for creating this product, we'd be grateful if you add it in a prominent place.
You can use the [`attributionLogo`](https://tradingview.github.io/lightweight-charts/docs/api/interfaces/LayoutOptions#attributionLogo) chart option for displaying an appropriate link to <https://www.tradingview.com/> on the chart itself, which will satisfy the link requirement.
[demo-url]: https://www.tradingview.com/lightweight-charts/

13
src/model/layout-options.ts
View File

@ -79,13 +79,14 @@ export interface LayoutOptions {
fontFamily: string;
/**
* Display the 'Charting by TradingView' attribution logo on the main chart pane.
* Display the TradingView attribution logo on the main chart pane.
*
* The licence for library specifies that you shall add the "attribution notice"
* from the NOTICE file and a link to \<https://www.tradingview.com/\> to the page
* of your website or mobile application that is available to your users. Using this
* attribution logo is sufficient for meeting this requirement. However, if you already
* fulfill this requirement then you can disable this attribution logo.
* The licence for library specifies that you add the "attribution notice"
* from the NOTICE file to your code and a link to https://www.tradingview.com/ to
* the page of your website or mobile application that is available to your users.
* Using this attribution logo is sufficient for meeting this linking requirement.
* However, if you already fulfill this requirement then you can disable this
* attribution logo.
*
* @defaultValue true
*/