@kvaser/canking-api

[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / CanIdentifierControlProps # Interface: CanIdentifierControlProps Properties of the CanIdentifierControl React component. ## Properties ### canIdentifier > **canIdentifier**: `string` The current CAN identifier. *** ### canIdentifierType > **canIdentifierType**: [`canIdentifierType`](../type-aliases/canIdentifierType.md) The current CAN identifier type, 'extended or 'standard'. *** ### 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. *** ### disableSelectMessageButton? > `optional` **disableSelectMessageButton**: `boolean` Set to true if the select message button should be disabled. *** ### disableSelectSignalButton? > `optional` **disableSelectSignalButton**: `boolean` Set to true if the select signal button should be disabled. *** ### 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. *** ### onCanIdentifierChange() > **onCanIdentifierChange**: (`identifier`, `idType`, `sourceId`) => `void` Callback that will be called when the CAN identifier has changed. #### Parameters ##### identifier `string` The new CAN identifier. ##### idType [`canIdentifierType`](../type-aliases/canIdentifierType.md) The new CAN identifier type. ##### sourceId The source identifier of the selected message. Could be undefined if no (any) source is selected. `string` | `undefined` #### Returns `void` *** ### 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` *** ### onSignalChange()? > `optional` **onSignalChange**: (`identifier`, `idType`, `signal`, `sourceId`) => `void` Callback that will be called when the settings have changed after selecting a signal. If this property is set, then the onCanIdentifierChange callback will not be called. #### Parameters ##### identifier `string` The new CAN identifier. ##### idType [`canIdentifierType`](../type-aliases/canIdentifierType.md) The new CAN identifier type. ##### signal The new signal or undefined if no signal is selected. [`SignalDefinition`](../../models/interfaces/SignalDefinition.md) | `undefined` ##### sourceId The source identifier of the selected signal. Could be undefined if no (any) source is selected. `string` | `undefined` #### 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. *** ### selectedSourceId? > `optional` **selectedSourceId**: `string` The source identifier of the selected message or signal. *** ### showSelectSignalButton? > `optional` **showSelectSignalButton**: `boolean` Set to true if the select signal button should be visible. If set to true, then the select message button will be hidden. *** ### showSource? > `optional` **showSource**: `boolean` Set to true if the source field should be shown. Default is false. *** ### 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.