@@ -15,13 +15,13 @@ import { NonCancelableEventHandler } from "../internal/events";
1515 */
1616export interface BaseChartOptions {
1717 /**
18- * The Highcharts instance, that can be obtained using `import Highcharts from "highcharts"`.
18+ * The Highcharts instance, which can be obtained using `import Highcharts from "highcharts"`.
1919 * Supported Highcharts versions: 12.
2020 */
2121 highcharts : null | object ;
2222
2323 /**
24- * Custom content that renders when `highcharts` is null. It renders a spinner if not defined.
24+ * Custom content that renders when `highcharts= null` . It renders a spinner if not defined.
2525 */
2626 fallback ?: React . ReactNode ;
2727
@@ -73,11 +73,11 @@ export interface BaseChartOptions {
7373 /**
7474 * Defines options to represent empty, no-match, loading, and error state of the chart, including:
7575 * * `statusType` (optional, "finished" | "loading" | "error") - Specifies the current status of loading data.
76- * * `empty` (slot) - Content, displayed when the chart data is empty.
77- * * `no-match` (slot) - Content, displayed when there is no data to display due to the built-in filtering.
78- * * `loading` (optional, slot) - Content, displayed when `statusType="loading"`. If omitted, the default loading state
76+ * * `empty` (slot) - Content displayed when the chart data is empty.
77+ * * `no-match` (slot) - Content displayed when there is no data to display due to the built-in filtering.
78+ * * `loading` (optional, slot) - Content displayed when `statusType="loading"`. If omitted, the default loading state
7979 * is shown, using `i18n.loadingText` or built-in i18n.
80- * * `error` (optional, slot) - Content, displayed when `statusType="error"`. If omitted, the default error state
80+ * * `error` (optional, slot) - Content displayed when `statusType="error"`. If omitted, the default error state
8181 * is shown, using `i18n.errorText` and `i18n.recoveryText` (when `onRecoveryClick` is provided), or built-in i18n.
8282 * * `onRecoveryClick` (optional, function) - Called when the user clicks the recovery button that appears when using default error
8383 * state, and only if `onRecoveryClick` is provided. Use this to enable the user to retry a failed request or provide another option
@@ -126,14 +126,14 @@ export interface WithCartesianI18nStrings {
126126 * @i 18n
127127 *
128128 * Available properties:
129- * * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to ` "loading".
130- * * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to ` "error".
129+ * * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to "loading".
130+ * * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to "error".
131131 * * `recoveryText` (optional, string) - Text for the recovery button, displayed next to the error text.
132132 * * `seriesFilterLabel` (optional, string) - Text for the visible label of the default series filter.
133133 * * `seriesFilterPlaceholder` (optional, string) - Text for the default series filter placeholder.
134134 * * `seriesFilterSelectedAriaLabel` (optional, string) - ARIA label of the default series filter which is appended to any option that is selected.
135135 * * `legendAriaLabel` (optional, string) - ARIA label that is associated with the legend in case there is no visible `legend.title` defined.
136- * * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for details popover dismiss button.
136+ * * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for the details popover dismiss button.
137137 * * `chartAccessibleDescription` (optional, string) - Accessible description of the chart plot area, e.g. "interactive chart".
138138 * * `xAxisAccessibleDescription` (optional, string) - Accessible description of the x axis, e.g. "x axis".
139139 * * `yAxisAccessibleDescription` (optional, string) - Accessible description of the y axis, e.g. "y axis".
@@ -147,14 +147,14 @@ export interface WithPieI18nStrings {
147147 * @i 18n
148148 *
149149 * Available properties:
150- * * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to ` "loading".
151- * * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to ` "error".
150+ * * `loadingText` (optional, string) - Text, displayed when the chart is loading, i.e. when `noData.statusType` is set to "loading".
151+ * * `errorText` (optional, string) - Text, displayed when the chart is in error state, i.e. when `noData.statusType` is set to "error".
152152 * * `recoveryText` (optional, string) - Text for the recovery button, displayed next to the error text.
153153 * * `seriesFilterLabel` (optional, string) - Text for the visible label of the default series filter.
154154 * * `seriesFilterPlaceholder` (optional, string) - Text for the default series filter placeholder.
155155 * * `seriesFilterSelectedAriaLabel` (optional, string) - ARIA label of the default series filter which is appended to any option that is selected.
156156 * * `legendAriaLabel` (optional, string) - ARIA label that is associated with the legend in case there is no visible `legend.title` defined.
157- * * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for details popover dismiss button.
157+ * * `detailPopoverDismissAriaLabel` (optional, string) - ARIA label for the details popover dismiss button.
158158 * * `chartAccessibleDescription` (optional, string) - Accessible description of the chart plot area, e.g. "interactive chart".
159159 * * `segmentAccessibleDescription` (optional, string) - Accessible description of the segment.
160160 */
0 commit comments