Skip to content

Commit ea8b95e

Browse files
authored
Merge branch 'main' into feat/custom-features-and-user-feedback
2 parents 119d4db + e36e4c9 commit ea8b95e

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

content/workspace/developers/json-specs/widgets-json-reference.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,16 @@ A `Widgets.json` table is a configuration structure with any of the named attrib
218218
Ignores stored cell range for the chart.
219219
_Example:_ `false`
220220

221+
- **chartNavigatorEnabled**
222+
_Type:_ `boolean`
223+
Shows the chart navigator bar below the chart, allowing users to pan and zoom through the range.
224+
_Example:_ `true`
225+
226+
- **chartMiniChartEnabled**
227+
_Type:_ `boolean`
228+
Displays a mini chart overview below the main chart for quick navigation and context.
229+
_Example:_ `true`
230+
221231
- **columnsDefs**
222232
_Type:_ list of objects, each containing the following keys:
223233

content/workspace/developers/widget-types/aggrid-table-charts.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -766,6 +766,38 @@ The following example shows the ChartView interface:
766766

767767
The highlighted ChartView option enables seamless conversion between table and chart views.
768768

769+
### Chart Navigator
770+
771+
Enable the navigator bar below the chart to pan and zoom across the data range. Set `chartNavigatorEnabled: true` inside the `chartView` configuration.
772+
773+
<div style={{display: 'flex', justifyContent: 'center'}}>
774+
<img className="pro-border-gradient" width="800" alt="chart-navigator" src="https://openbb-assets.s3.us-east-1.amazonaws.com/docs/pro/chartnav.png" />
775+
</div>
776+
777+
```python
778+
"chartView": {
779+
"enabled": True,
780+
"chartType": "line",
781+
"chartNavigatorEnabled": True
782+
}
783+
```
784+
785+
### Chart Mini Chart
786+
787+
Display a mini chart overview next to the main chart for quick context and navigation. Set `chartMiniChartEnabled: true` inside the `chartView` configuration.
788+
789+
<div style={{display: 'flex', justifyContent: 'center'}}>
790+
<img className="pro-border-gradient" width="800" alt="chart-mini-chart" src="https://openbb-assets.s3.us-east-1.amazonaws.com/docs/pro/nav2.png" />
791+
</div>
792+
793+
```python
794+
"chartView": {
795+
"enabled": True,
796+
"chartType": "line",
797+
"chartMiniChartEnabled": True
798+
}
799+
```
800+
769801
### Available Chart Types
770802

771803
The built-in charts support a variety of types. Here are the allowed values:

0 commit comments

Comments
 (0)