Module api

Module api 

Source

Modules§

always_connect_disconnected_values
axis_display_options
axis_domain_type
axis_id
axis_position
axis_range
axis_scale_type
axis_threshold_group
axis_threshold_visualization
bit_flag
bit_flag_map_cell_config
bit_flag_map_raw_visualisation
bit_flag_map_visualisation
cartesian_chart_definition
cartesian_chart_definition_v1
cartesian_plot
checklist_chart_definition
checklist_chart_definition_v1
color_style
data_source_ref_name
default_fill
disconnected_value_visualization
enum_cell_config
enum_group_by_sort
enum_group_by_sort_custom
enum_raw_visualisation
enum_value_channel
enum_value_visualisation
event
figure
frequency_chart_definition
frequency_chart_definition_v1
frequency_plot
frequency_plot_type
frequency_plot_type_fft
frequency_plot_type_periodogram
geo3d_custom_model
geo3d_default_model
geo3d_definition
geo3d_definition_v1
geo3d_model
geo3d_orientation
geo3d_orientation_principal_axes
geo3d_position
geo3d_position_wgs84
geo_additional_tileset
geo_additional_variable
geo_base_tileset
geo_custom_feature
geo_line3d_style
geo_line_style
geo_plot3d
geo_plot3d_visualization_options
geo_plot_from_lat_long
geo_plot_secondary_visibility_config
geo_plot_visualization_options
geo_point
geo_secondary_plot_visualization_option
geo_viz_definition
geo_viz_definition_v1
histogram_chart_definition
histogram_chart_definition_v1
histogram_display_settings
histogram_plot
histogram_sort_order
layout
line_style
line_style_v1
line_threshold
line_threshold_group
log_channel
log_column_name
log_panel_definition
log_panel_definition_v1
log_tag_filter
never_connect_disconnected_values
number_format
number_format_display_option
numeric_bar_gauge_visualisation
numeric_bar_visualisation_v2
numeric_cell_config
numeric_group_by_sort
numeric_raw_visualisation
numeric_raw_visualisation_v2
numeric_value_channel
numeric_value_visualisation
numeric_value_visualisation_v2
overlay_scope
persist_all
persist_by_value
persist_value_overlay
plotly_panel_definition
plotly_panel_definition_v1
plotly_preset
position
procedure_viz_definition
procedure_viz_definition_v1
range_cell_config
range_group_by_sort
range_raw_visualisation
range_value_channel
range_value_visualisation
scatter3d_decimation_strategy
scatter3d_trace_compute_config
staleness_cell_config
staleness_configuration
staleness_visualisation
threshold
threshold_disconnected_values
threshold_line_style
threshold_shading_config
time_series_chart_definition
time_series_chart_definition_v1
time_series_enum_plot
time_series_numeric_plot
time_series_plot
time_series_plot_config
time_series_plot_v2
time_series_range_plot
time_series_row
trace
trace_compute
trace_compute_config
value_axis
value_sort
value_table_cell
value_table_cell_config
value_table_channel
value_table_definition
value_table_definition_v1
value_table_definition_v2
value_table_grid_row_column_config
value_table_grid_value_table_cell
value_table_layout
value_table_layout_grid
value_table_multi_cell_config
value_table_staleness_config
value_to_color_map
video_panel_data_source
video_viz_definition
video_viz_definition_v1
viz_definition
workbook_viz_definition_map

Structs§

AlwaysConnectDisconnectedValues
This option indicates that disconnected values will always be connected with a line.
AxisDisplayOptions
AxisId
AxisRange
AxisThresholdVisualization
BitFlag
The settings for a bit flag mapping. Each position should be unique. Position 0 represents the least significant bit and position 31 represents the most significant bit.
BitFlagMapCellConfig
BitFlagMapRawVisualisation
The settings for a raw bit flag map visualisation.
CartesianChartDefinitionV1
CartesianPlot
ChecklistChartDefinitionV1
DataSourceRefName
DefaultFill
EnumCellConfig
EnumGroupBySortCustom
EnumRawVisualisation
The settings for a raw enum visualisation.
EnumValueChannel
Event
Figure
The root figure definition for a plotly instance
FrequencyChartDefinitionV1
FrequencyPlot
FrequencyPlotTypeFft
FrequencyPlotTypePeriodogram
Geo3dCustomModel
Geo3dDefinitionV1
Geo3dOrientationPrincipalAxes
Geo3dPositionWgs84
GeoAdditionalVariable
GeoPlot3d
GeoPlot3dVisualizationOptions
GeoPlotFromLatLong
GeoPlotSecondaryVisibilityConfig
GeoPlotVisualizationOptions
GeoPoint
A static coordinate on the map
GeoVizDefinitionV1
HistogramChartDefinitionV1
HistogramDisplaySettings
HistogramPlot
Layout
LineThreshold
LineThresholdGroup
Line thresholds are used to mark values or demarcate regions along a single axis.
LogChannel
A field to save additional column names on log panels with support for multiple variables
LogColumnName
LogPanelDefinitionV1
LogTagFilter
Tag field to filter log series data by. Although the tag values is an array, we currently only support a single string key value pair to filter logs.
NeverConnectDisconnectedValues
This option indicates that disconnected values are never connected with a line.
NumberFormat
Number format for numeric cells, eg 1e4 | 10000 | 10,000.
NumericBarGaugeVisualisation
The settings for a bar gauge visualisation.
NumericBarVisualisationV2
A numeric visualisation that will fill the cell from left to right with a colored background representing where the value falls inside a set range. The lowest and highest values in the thresholds determine the start and end of the range. Middle threshold values will still affect the cell’s coloration.
NumericCellConfig
NumericRawVisualisation
NumericRawVisualisationV2
A raw numeric visualisation with optional coloring based on numeric thresholds.
NumericValueChannel
PersistAll
PersistByValue
PlotlyPanelDefinitionV1
ProcedureVizDefinitionV1
RangeCellConfig
RangeRawVisualisation
The settings for a raw range visualisation.
RangeValueChannel
Scatter3dTraceComputeConfig
StalenessCellConfig
StalenessConfiguration
Threshold
ThresholdDisconnectedValues
NOTE this is deprecated and will be translated to NeverConnectDisconnectedValues by the frontend. This option indicates the duration below which disconnected values will always be connected with a line.
TimeSeriesChartDefinitionV1
TimeSeriesEnumPlot
TimeSeriesNumericPlot
TimeSeriesPlot
TimeSeriesPlotV2
TimeSeriesRangePlot
TimeSeriesRow
Trace
TraceCompute
ValueAxis
ValueSort
ValueTableCell
ValueTableDefinitionV1
ValueTableDefinitionV2
ValueTableGridRowColumnConfig
ValueTableGridValueTableCell
ValueTableLayoutGrid
A 2D grid layout for the value table where cells are laid out in specific rows and columns. Supports hierarchical cell visualisation configurations, favoring when present: the cell’s own definition, then the column’s, then the row’s, then the panel’s.
ValueTableMultiCellConfig
Configurations for each type of cell in a grouping of heterogenous cells, such as for a row, for a column, or for the entire grid.
ValueTableStalenessConfig
Configuration for showing staleness of values while streaming
VideoPanelDataSource
Enhanced video panel data source to be compatible with multiple assets
VideoVizDefinitionV1
WorkbookVizDefinitionMap

Enums§

AxisDomainType
AxisPosition
AxisScaleType
AxisThresholdGroup
BitFlagMapVisualisation
CartesianChartDefinition
ChecklistChartDefinition
ColorStyle
DisconnectedValueVisualization
EnumGroupBySort
EnumValueVisualisation
FrequencyChartDefinition
FrequencyPlotType
Geo3dDefaultModel
Geo3dDefinition
Geo3dModel
Geo3dOrientation
Geo3dPosition
GeoAdditionalTileset
A standard tileset to overlay on the base map.
GeoBaseTileset
The base map style. Default STREET if unspecified.
GeoCustomFeature
GeoLine3dStyle
GeoLineStyle
GeoSecondaryPlotVisualizationOption
GeoVizDefinition
HistogramChartDefinition
HistogramSortOrder
The order in which the histogram should be sorted. Default is VALUE_ASCENDING.
LineStyle
LineStyleV1
LogPanelDefinition
NumberFormatDisplayOption
NumericGroupBySort
NumericValueVisualisation
NumericValueVisualisationV2
OverlayScope
PersistValueOverlay
PlotlyPanelDefinition
PlotlyPreset
Position
ProcedureVizDefinition
RangeGroupBySort
RangeValueVisualisation
Scatter3dDecimationStrategy
StalenessVisualisation
ThresholdLineStyle
ThresholdShadingConfig
Specifies how areas of a plot should be shaded in relation to the defined threshold lines. Will eventually include other shading configurations, like a buffer zone.
TimeSeriesChartDefinition
TimeSeriesPlotConfig
TraceComputeConfig
ValueTableCellConfig
ValueTableChannel
ValueTableDefinition
ValueTableLayout
ValueToColorMap
VideoVizDefinition
VizDefinition