UNPKG

@kvaser/canking-api

Version:

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

200 lines (103 loc) 3.51 kB
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / LinIdentifierGeneratorControlProps # Interface: LinIdentifierGeneratorControlProps Properties of the LinIdentifierGeneratorControl 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. *** ### identifierGeneratorType > **identifierGeneratorType**: [`linIdentifierGeneratorType`](../type-aliases/linIdentifierGeneratorType.md) The generator type: 'constant' | 'random' | 'scan' 'constant': The LIN identifier set to linIdentifier will be used for all generated messages. 'random': A random LIN identifier between minLinIdentifier and maxLinIdentifier will be used. 'scan': A LIN identifier will be picked from minLinIdentifier to maxLinIdentifier. *** ### linIdentifier > **linIdentifier**: `string` The LIN identifier. *** ### maxLinIdentifier > **maxLinIdentifier**: `string` The max LIN identifier that will be used if identifierGeneratorType is 'random' or 'scan'. *** ### minLinIdentifier > **minLinIdentifier**: `string` The min LIN identifier that will be used if identifierGeneratorType is 'random' or 'scan'. *** ### 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. *** ### onChange() > **onChange**: (`newLinIdentifier`, `newIdentifierGeneratorType`, `newMinLinIdentifier`, `newMaxLinIdentifier`) => `void` Callback that will be called when the LIN identifier(s) has changed. #### Parameters ##### newLinIdentifier `string` The new constant LIN identifier. ##### newIdentifierGeneratorType [`linIdentifierGeneratorType`](../type-aliases/linIdentifierGeneratorType.md) The new generator type. ##### newMinLinIdentifier `string` The new min LIN identifier. ##### newMaxLinIdentifier `string` The new max LIN identifier. #### 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` *** ### 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. *** ### 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.