Web SDK documentation
  1. Injectables
  2. EchartsOptionsService

File

echart/services/echarts-options.service.ts

Index

Properties
Methods

Constructor

constructor(datePipe: DatePipe, yAxisService: YAxisService, chartTypesService: ChartTypesService, severityIconPipe: AlarmSeverityToIconPipe, severityLabelPipe: AlarmSeverityToLabelPipe, router: Router)
Parameters :
Name Type Optional
datePipe DatePipe No
yAxisService YAxisService No
chartTypesService ChartTypesService No
severityIconPipe AlarmSeverityToIconPipe No
severityLabelPipe AlarmSeverityToLabelPipe No
router Router No

Methods

calculateExtendedIntervalInMs
calculateExtendedIntervalInMs(interval, selectedTimeRange)
Parameters :
Name Optional
interval No
selectedTimeRange No
Returns : number
getAggregatedSeries
getAggregatedSeries(aggregatedDatapoints: DpWithValues[])
Parameters :
Name Type Optional
aggregatedDatapoints DpWithValues[] No
Returns : SeriesOption[]
getAlarmOrEventSeries
getAlarmOrEventSeries(dp: DpWithValues, renderType: DatapointChartRenderType, isMinMaxChart, items: IAlarm[] | IEvent[], itemType: "alarm" | "event", displayOptions: object, id?: string | number, idx?: number, realtime?: boolean)

This method is used to get the series for alarms and events.

Parameters :
Name Type Optional Default value Description
dp DpWithValues No
  • The data point.
renderType DatapointChartRenderType No
  • The render type.
isMinMaxChart No false
  • If the chart is min max chart.
items IAlarm[] | IEvent[] No []
  • All alarms or events which should be displayed on the chart.
itemType "alarm" | "event" No 'alarm'
  • The item type.
displayOptions object No { displayMarkedLine: true, displayMarkedPoint: true }
id string | number Yes
  • The id of the device
idx number Yes
realtime boolean Yes
Returns : CustomSeriesOptions[]
getChartOptions
getChartOptions(datapointsWithValues: DpWithValues[], timeRange: literal type, showSplitLines: literal type, events: IEvent[], alarms: IAlarm[], displayOptions: literal type, selectedTimeRange?: literal type | null, aggregatedDatapoints?: DpWithValues[], sliderZoomUsed)
Parameters :
Name Type Optional Default value
datapointsWithValues DpWithValues[] No
timeRange literal type No
showSplitLines literal type No
events IEvent[] No
alarms IAlarm[] No
displayOptions literal type No
selectedTimeRange literal type | null Yes
aggregatedDatapoints DpWithValues[] Yes
sliderZoomUsed No false
Returns : EChartsOption
getTooltipFormatterForAlarmAndEvents
getTooltipFormatterForAlarmAndEvents(tooltipParams: CallbackDataParams, params: literal type, allEvents: IEvent[], allAlarms: IAlarm[])

This method is used to get tooltip formatter for alarms and events.

Parameters :
Name Type Optional Description
tooltipParams CallbackDataParams No
  • The tooltip parameters.
params literal type No
  • The parameters data.
allEvents IEvent[] No
  • All events.
allAlarms IAlarm[] No
  • All alarms.
Returns : string

The formatted string for the tooltip.

Properties

echartsInstance
Type : ECharts | undefined

results matching ""

    No results matching ""