@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
98 lines (49 loc) • 1.56 kB
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / LinChannelSelectControlProps
Interface: LinChannelSelectControlProps
Properties of the LinChannelSelectControl 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.
***
## onChannelIdentifierChange()
**onChannelIdentifierChange**: (`identifier`) => `void`
Callback that will be called when a new channel has been selected.
### Parameters
#### identifier
`string`
The new channel identifier.
### Returns
`void`
***
## selectMasterChannels
**selectMasterChannels**: `boolean`
If true, master channels will be selected and otherwise slave channels.