UNPKG

@kvaser/canking-api

Version:

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

87 lines (45 loc) • 1.51 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
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SelectMessageDialogProps # Interface: SelectMessageDialogProps Properties of the SelectMessageDialog React component. ## Properties ### modal? > `optional` **modal**: `boolean` Whether the dialog should be modal or not. Default is false. *** ### nodeIdentifier? > `optional` **nodeIdentifier**: `string` Optional node identifier to limit the databases to those available on the specified node. If not specified, all databases available in the system will be shown. *** ### onClose() > **onClose**: () => `void` Callback that is called when the dialog is closed. #### Returns `void` *** ### onSelect() > **onSelect**: (`message`, `sourceId`) => `void` Callback that is called when a message is selected. The selected message and source identifier are passed as parameters. #### Parameters ##### message [`FrameDefinition`](../../models/interfaces/FrameDefinition.md) ##### sourceId `string` #### Returns `void` *** ### open > **open**: `boolean` If true, the dialog is open. *** ### parentDialogTitle? > `optional` **parentDialogTitle**: `string` Optional title of the parent dialog to be shown in the title bar as a breadcrumb. *** ### 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.