UNPKG

@kvaser/canking-api

Version:

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

153 lines (78 loc) • 2.67 kB
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / CanIdentifierFrameControlProps # Interface: CanIdentifierFrameControlProps Properties of the CanIdentifierFrameControl React component. ## Properties ### collapsed? > `optional` **collapsed**: `boolean` Current collapse state of the SectionControl. *** ### collapsedChange()? > `optional` **collapsedChange**: (`value`) => `void` Callback that will be called when collapse state has changed. #### Parameters ##### value `boolean` The new collapse state. #### Returns `void` *** ### collapsible? > `optional` **collapsible**: `boolean` Set to true if the SectionControl should be collapsible. *** ### disableSelectMessageButton? > `optional` **disableSelectMessageButton**: `boolean` Set to true if the select message button should be disabled. *** ### frame > **frame**: [`WriteFrame`](../../models/interfaces/WriteFrame.md) The frame object that holds the CAN identifier. *** ### fullScreen? > `optional` **fullScreen**: `boolean` Set to true if the select message and select signal dialogs should be full screen dialogs. *** ### hideSection? > `optional` **hideSection**: `boolean` Set to true if this control shouldn't be encapsulated inside a SectionControl. *** ### hideSelectMessageButton? > `optional` **hideSelectMessageButton**: `boolean` Set to true if the select message button should be hidden. *** ### nodeIdentifier? > `optional` **nodeIdentifier**: `string` Identifier of the node that will be used to filter messages and signals in the select dialogs. Leave undefined if no filtering should be done. *** ### onErrorsChange()? > `optional` **onErrorsChange**: (`errors`) => `void` Callback that will be called when the errors state has changed. #### Parameters ##### errors `boolean` The new errors state. #### Returns `void` *** ### onFrameChange() > **onFrameChange**: (`value`) => `void` Callback that will be called when the frame is updated after the CAN identifier has changed. #### Parameters ##### value [`WriteFrame`](../../models/interfaces/WriteFrame.md) The new frame object. #### Returns `void` *** ### parentDialogTitle? > `optional` **parentDialogTitle**: `string` Name of a parent dialog, if any, that is used as the parent for the select message and select signal dialogs. Leave undefined if there is no parent dialog. *** ### sourceIdFilter? > `optional` **sourceIdFilter**: `string` The source identifier that will be used to filter messages in the select dialog. Leave undefined if no filtering should be done.