Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex-NRCan authored Nov 30, 2023
1 parent 4247404 commit 75cf972
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,13 @@ There are 3 essential props for this component: inputs, data and options.
- ui.ySlider?: groups information on the y slider;
- ui.ySlider.display?: indicates if the slider should be displayed;
- ui.ySlider.steps?: indicates the steps the slider should jump when sliding;
- ui.stepsSwitcher: indicates if the select drop down to switch the steps on-the-fly is displayed;
- ui.resetStates: indicates if the button to reset the states is displayed;
- ui.description: indicates the description text to show at the bottom of the chart;
- ui.download: indicates if a download button should be displayed;
- ui.stepsSwitcher?: indicates if the select drop down to switch the steps on-the-fly is displayed;
- ui.resetStates?: indicates if the button to reset the states is displayed;
- ui.description?: indicates the description text to show at the bottom of the chart;
- ui.download?: indicates if a download button should be displayed;
- datasources: groups information on the datasources to build the datasource drop down and the chart;
- datasources.display: indicates the string to be displayed in the drop down;
- datasources.value: indicates the inner value used for the `sourceItem`;
- datasources.sourceItem: indicates the source item used as reference to query the data from. This property has an object with a property that should equal the property in `query.queryOptions.whereClauses.valueFrom`;
- datasources.items?: indicates the actual `items`, associated with the `datasources.sourceItem`, used to build the chart with. When `items` is specified, the data isn't fetched with the `query.url`;
- chartjsOptions?: indicates further `ChartJS specific` `options` to open the door to further customization when natively supported by `ChartJS` (ref: [here](https://www.chartjs.org/docs/latest/general/options.html));
Expand Down

0 comments on commit 75cf972

Please sign in to comment.