Add new Chart3D to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Add new ChartXY to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Add new FunnelChart to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Add new GaugeChart to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Create a new LegendBoxPanel to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Add new PieChart to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Add new PyramidChart to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboard's numberOfColumns/Rows.
Add new SpiderChart to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Create a container for UI objects on dashboard with specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Add new ZoomBandChart to dashboard at specified location and span.
Throws an error if either column/row index is less than 0 or index + span is more than Dashboards numberOfColumns/Rows.
Public, safe interface for Dashboards rendering engine.
Add a stand-alone LegendBox using a builder.
UIElementBuilder. If omitted, Horizontal LegendBoxBuilder will be selected. Use LegendBoxBuilders for selection.
Optional custom scale to position UIElement on. Defaults to whole Dashboard in percentages [0, 100].
Object that fulfills interfaces: UIElementType (typeparam) and UIElement
Add a stand-alone UIElement using a builder.
UIElementBuilder. If omitted, TextBoxBuilder will be selected. Use UIElementBuilders for selection.
Optional custom scale to position UIElement on. Defaults to whole Dashboard in percentages [0, 100].
Object that fulfills interfaces: UIElementType (typeparam) and UIElement
Disable all animations for all charts in the dashboard.
After calling this function, animations (Zooming, scaling) for all Charts will be disabled. Animations must be recreated manually for each chart afterwards.
Dashboard itself for fluent interface.
Permanently dispose the component.
To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.
let chart = ...ChartXY()
let axisX = chart.getDefaultAxisX()
// Dispose Chart, and remove all references so that they can be garbage-collected.
chart.dispose()
chart = undefined
axisX = undefinedObject itself for fluent interface
Use forEach function on charts inside dashboard. Dashboard filters any other types of cells out.
forEach function for Chart
Get fillStyle of dashboard
FillStyle
Get stroke style of dashboard background.
LineStyle
Get the minimum and maximum vertical boundaries used for the Dashboard.
Vertical boundaries as a tuple [minSize, maxSize]
Get style of Dashboard splitters.
LineStyle object
Get style of Dashboard splitters when highlighted.
LineStyle object
Get theme used for the dashboard.
Theme
Get the minimum and maximum horizontal boundaries used for the Dashboard.
Horizontal boundaries as a tuple [minSize, maxSize]
Use mapping function on all charts inside dashboard. Dashboard filters any other types of cells out.
Map function for Chart
Capture rendered state in an image file. Prompts the browser to download the created file.
NOTE: The download might be blocked by browser/plugins as harmful. To prevent this, only call the method in events tied to user-interactions. From mouse-event handlers, for example.
Has two optional parameters which directly reference JavaScript API HTMLCanvasElement.toDataURL. For supported image formats, compression quality, Etc. refer to:
https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL
Example usage:
// Download 'screenshot.png'
Dashboard.saveToFile('screenshot')
// Attempt download 'maybeNotSupported.bmp'
Dashboard.saveToFile('maybeNotSupported', 'image/bmp')
// Attempt download jpeg.file with specified compression quality
Dashboard.saveToFile('fileName', 'image/jpeg', 0.50)Name of prompted download file as string. File extension shouldn't be included as it is automatically detected from 'type'-argument.
A DOMString indicating the image format. The default format type is image/png.
A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If this argument is anything else, the default value for image quality is used. The default value is 0.92.
Set fillStyle of dashboard background.
FillStyle or mutator to modify existing one
Object itself
Set stroke style of dashboard background.
LineStyle
Object itself
Set width of a column. By default column widths are equal.
Example usage:
// Dashboard with 3 columns with widths (20%, 20%, 60%) of dashboard width
dashboard.setColumnWidth( 0, 1 )
dashboard.setColumnWidth( 1, 1 )
dashboard.setColumnWidth( 2, 3 )Index of the column (starts from 0)
Relative width of the column
Set the minimum and maximum boundaries for dashBoard vertical size.
Single value applied to both minimum and maximum size, or a tuple for [min, max] size in pixels.
Set height of a row. By default row heights are equal.
Example usage:
// Dashboard with 3 rows with heights (20%, 20%, 60%) of dashboard height
dashboard.setRowHeight( 0, 1 )
dashboard.setRowHeight( 1, 1 )
dashboard.setRowHeight( 2, 3 )Index of the row (starts from 0)
Relative height of the row
Set style of Dashboard splitters.
Example usage:
// Specified LineStyle
Dashboard.setSplitterStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
Dashboard.setSplitterStyle((solidLine) => solidLine.setThickness(5))
// Hidden
Dashboard.setSplitterStyle(emptyLine)Either a LineStyle object or a function, which will be used to create a new LineStyle based on current value.
Chart itself
Set style of Dashboard splitters when highlighted.
Example usage:
// Specified LineStyle
Dashboard.setSplitterStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
Dashboard.setSplitterStyle((solidLine) => solidLine.setThickness(5))
// Hidden
Dashboard.setSplitterStyle(emptyLine)Either a LineStyle object or a function, which will be used to modify current value or undefined for automatic value based on normal style.
Chart itself
Set the minimum and maximum boundaries for dashBoard horizontal size.
Single value for static engine size, or a tuple for size range [min, max] in pixels.
Dashboard is a component for flexible positioning of multiple Charts efficiently.
Upon its creation an amount of columns and rows is specified. Charts and other components can then be placed in cells with given column and row-locations and sizes (using methods of Dashboard. For example: Dashboard.createChartXY.
The Dashboard will distribute the available space for columns and rows, which users can resize with mouse and touch interactions.