UNPKG

@kvaser/canking-api

Version:

CanKing API to communicate with the CanKing service using Node.js.

44 lines (22 loc) • 976 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSignalDataEnvelopes # Function: useSignalDataEnvelopes() > **useSignalDataEnvelopes**(`id`, `subscriptionName`, `subscribedSignals`, `view`): [`ISignalDataEnvelope`](../interfaces/ISignalDataEnvelope.md)[] A hook for extracting signal data envelopes to be used for graphical visualization. ## Parameters ### id `number` The unique id of the view. ### subscriptionName `string` The subscription name for the data. Must be unique per view. ### subscribedSignals `object`[] The subscribed signals with their qualified names and optional source identifiers. ### view [`IEnvelopeView`](../interfaces/IEnvelopeView.md) Optional view parameters to define the time range and width for the envelopes. ## Returns [`ISignalDataEnvelope`](../interfaces/ISignalDataEnvelope.md)[] The extracted signal data envelopes.