UNPKG

@kvaser/canking-api

Version:

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

104 lines (52 loc) 1.69 kB
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / CanChannelSelectControlProps # Interface: CanChannelSelectControlProps Properties of the CanChannelSelectControl React component. ## Properties ### channelIdentifier > **channelIdentifier**: `string` Identifier of the selected channel. *** ### 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, ignored if hideSectionControl is true. *** ### disabled? > `optional` **disabled**: `boolean` Set to true to disable this control. *** ### hideSectionControl? > `optional` **hideSectionControl**: `boolean` Set to true if this control shouldn't be encapsulated inside a SectionControl. *** ### hideSilentChannels? > `optional` **hideSilentChannels**: `boolean` Set to true to hide all silent channels e.g., when the control is used for selecting output channel. *** ### onChannelIdentifierChange() > **onChannelIdentifierChange**: (`identifier`, `canFdSupport`) => `void` Callback that will be called when a new channel has been selected. #### Parameters ##### identifier `string` The new channel identifier. ##### canFdSupport `boolean` True if the new CAN channel supports CAN-FD. #### Returns `void`