Enhancements:

- added the `create_histogram` method and the `Histogram` object.
- added the `round` parameter to `trend_line` and `ray_line`
- chart.set can now be given line data.

Bug Fixes:
- `NaN` values can now be given when setting data, and will leave a blank space in the data.
- `resize` will now change the chart wrapper’s size as well as the chart itself.
This commit is contained in:
louisnw
2023-09-04 20:29:15 +01:00
parent 8532d48e5d
commit 555573b54b
8 changed files with 185 additions and 63 deletions

View File

@ -59,7 +59,19 @@ ___
Creates and returns a Line object, representing a `LineSeries` object in Lightweight Charts and can be used to create indicators. As well as the methods described below, the `Line` object also has access to:
[`marker`](#marker), [`horizontal_line`](#AbstractChart.horizontal_line) [`hide_data`](#hide_data), [`show_data`](#show_data) and[`price_line`](#price_line).
[`marker`](#marker), [`horizontal_line`](#AbstractChart.horizontal_line), [`hide_data`](#hide_data), [`show_data`](#show_data) and [`price_line`](#price_line).
Its instance should only be accessed from this method.
```
___
```{py:method} create_histogram(name: str, color: COLOR, price_line: bool, price_label: bool, scale_margin_top: float, scale_margin_bottom: float) -> Histogram
Creates and returns a Histogram object, representing a `HistogramSeries` object in Lightweight Charts and can be used to create indicators. As well as the methods described below, the object also has access to:
[`horizontal_line`](#AbstractChart.horizontal_line), [`hide_data`](#hide_data), [`show_data`](#show_data) and [`price_line`](#price_line).
Its instance should only be accessed from this method.
```
@ -76,7 +88,7 @@ ___
```{py:method} trend_line(start_time: str | datetime, start_value: NUM, end_time: str | datetime, end_value: NUM, color: COLOR, width: int, style: LINE_STYLE) -> Line
```{py:method} trend_line(start_time: str | datetime, start_value: NUM, end_time: str | datetime, end_value: NUM, color: COLOR, width: int, style: LINE_STYLE, round: bool) -> Line
Creates a trend line, drawn from the first point (`start_time`, `start_value`) to the last point (`end_time`, `end_value`).
@ -85,7 +97,7 @@ ___
```{py:method} ray_line(start_time: str | datetime, value: NUM, color: COLOR, width: int, style: LINE_STYLE) -> Line
```{py:method} ray_line(start_time: str | datetime, value: NUM, color: COLOR, width: int, style: LINE_STYLE, round: bool) -> Line
Creates a ray line, drawn from the first point (`start_time`, `value`) and onwards.

View File

@ -0,0 +1,51 @@
# `Histogram`
````{py:class} Histogram(name: str, color: COLOR, style: LINE_STYLE, width: int, price_line: bool, price_label: bool)
The `Histogram` object represents a `HistogramSeries` object in Lightweight Charts and can be used to create indicators. As well as the methods described below, the `Line` object also has access to:
[`horizontal_line`](#AbstractChart.horizontal_line), [`hide_data`](#hide_data), [`show_data`](#show_data) and [`price_line`](#price_line).
Its instance should only be accessed from [`create_histogram`](#AbstractChart.create_histogram).
___
```{py:method} set(data: pd.DataFrame)
Sets the data for the histogram.
When a name has not been set upon declaration, the columns should be named: `time | value` (Not case sensitive).
The column containing the data should be named after the string given in the `name`.
A `color` column can be used within the dataframe to specify the color of individual bars.
```
___
```{py:method} update(series: pd.Series)
Updates the data for the histogram.
This should be given as a Series object, with labels akin to the `histogram.set` method.
```
___
```{py:method} scale(scale_margin_top: float, scale_margin_bottom: float)
Scales the margins of the histogram, as used within [`volume_config`](#AbstractChart.volume_config).
```
___
```{py:method} delete()
Irreversibly deletes the histogram.
```
````

View File

@ -4,6 +4,7 @@
:hidden:
abstract_chart
line
histogram
horizontal_line
charts
events

View File

@ -5,9 +5,9 @@
The `Line` object represents a `LineSeries` object in Lightweight Charts and can be used to create indicators. As well as the methods described below, the `Line` object also has access to:
[`marker`](#marker), [`horizontal_line`](#AbstractChart.horizontal_line) [`hide_data`](#hide_data), [`show_data`](#show_data) and [`price_line`](#price_line).
[`marker`](#marker), [`horizontal_line`](#AbstractChart.horizontal_line), [`hide_data`](#hide_data), [`show_data`](#show_data) and [`price_line`](#price_line).
Its instance should only be accessed from [create_line](#AbstractChart.create_line).
Its instance should only be accessed from [`create_line`](#AbstractChart.create_line).
___
@ -36,7 +36,7 @@ This should be given as a Series object, with labels akin to the `line.set()` fu
___
```{py:method} line.delete()
```{py:method} delete()
Irreversibly deletes the line.