UNPKG

@kvaser/canking-api

Version:

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

153 lines (78 loc) 2.67 kB
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / LinIdentifierFrameControlProps # Interface: LinIdentifierFrameControlProps Properties of the LinIdentifierFrameControl 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. *** ### disableSelectMessageButton? > `optional` **disableSelectMessageButton**: `boolean` Set to true if the select message button should be disabled. *** ### frame > **frame**: [`WriteFrame`](../../models/interfaces/WriteFrame.md) The frame object that holds the LIN identifier. *** ### 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. *** ### 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` *** ### onFrameChange() > **onFrameChange**: (`value`) => `void` Callback that will be called when the frame is updated after the LIN identifier has changed. #### Parameters ##### value [`WriteFrame`](../../models/interfaces/WriteFrame.md) The new frame object. #### 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. *** ### 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.