@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
155 lines (79 loc) • 2.64 kB
Markdown
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)
***
[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / LinIdentifierGeneratorSettingsControlProps
# Interface: LinIdentifierGeneratorSettingsControlProps
Properties of the LinIdentifierGeneratorSettingsControl 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.
***
### disabled?
> `optional` **disabled**: `boolean`
Set to true to disable this control.
***
### fullScreen?
> `optional` **fullScreen**: `boolean`
Set to true if the select message dialog should be a full screen dialog.
***
### nodeIdentifier?
> `optional` **nodeIdentifier**: `string`
Identifier of the node that will be used to filter messages in the select dialog.
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`
***
### onSettingsChange()
> **onSettingsChange**: (`value`) => `void`
Callback that will be called when the settings are updated after the LIN identifiers have changed.
#### Parameters
##### value
[`PeriodicTransmissionSettings`](../../models/interfaces/PeriodicTransmissionSettings.md)
The new settings object.
#### Returns
`void`
***
### parentDialogTitle?
> `optional` **parentDialogTitle**: `string`
Name of a parent dialog, if any, that is used as the parent for the select message dialog.
Leave undefined if there is no parent dialog.
***
### settings
> **settings**: [`PeriodicTransmissionSettings`](../../models/interfaces/PeriodicTransmissionSettings.md)
The settings object that holds the LIN identifier(s) generator settings.
***
### showSignalValuesTable()
> **showSignalValuesTable**: (`value`) => `void`
Callback for specifying if the signal values table should be visible.
#### Parameters
##### value
`boolean`
#### Returns
`void`
***
### 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.