@highcharts/dashboards
Version:
Highcharts Dashboards framework
44 lines (43 loc) • 1.25 kB
TypeScript
import type Component from '../Components/Component';
import type { Options as HighchartsOptions } from './HighchartsTypes';
export interface Options extends Component.Options {
/**
* Additional chart options used to render the navigator. Here you can
* change things like `chart.type`, `chart.height`, or `title.text`.
*
* @example
* ``` JavaScript
* {
* chartOptions: {
* chart: {
* height: '80px',
* type: 'column'
* },
* title: {
* text: 'My Navigator'
* }
* }
* }
* ```
*/
chartOptions: HighchartsOptions;
/**
* Column assignments have impact on navigator and range. Only the first
* assignment is used and usually matches against the `y` values.
*
* If crossfilter sync is enabled, the column assignment will show the
* distribution of values instead of the values themself.
*
* @example
* ``` JavaScript
* {
* columnAssignments: {
* 'My Column': 'y'
* }
* }
* ```
*/
columnAssignments?: Record<string, string | null>;
type: 'Navigator';
}
export default Options;