@kvaser/canking-api/doc_md/controls/interfaces/CanIdentifierGeneratorControlProps.md

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

[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md)

***

[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / CanIdentifierGeneratorControlProps

# Interface: CanIdentifierGeneratorControlProps

Properties of the CanIdentifierGeneratorControl React component.

## Properties

### canIdentifier

> **canIdentifier**: `string`

The CAN identifier.

***

### canIdentifierType

> **canIdentifierType**: [`canIdentifierType`](../type-aliases/canIdentifierType.md)

The CAN identifier type that will be used, '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.

***

### 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**: [`canIdentifierGeneratorType`](../type-aliases/canIdentifierGeneratorType.md)

The generator type: 'constant' | 'random' | 'scan'
'constant': The CAN identifier set to canIdentifier will be used for all generated messages.
'random': A random CAN identifier between minCanIdentifier and maxCanIdentifier will be used.
'scan': A CAN identifier will be picked from minCanIdentifier to maxCanIdentifier.

***

### maxCanIdentifier

> **maxCanIdentifier**: `string`

The max CAN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.

***

### minCanIdentifier

> **minCanIdentifier**: `string`

The min CAN 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**: (`newCanIdentifier`, `newIdentifierGeneratorType`, `newMinCanIdentifier`, `newMaxCanIdentifier`, `newIdentifierType`) => `void`

Callback that will be called when the CAN identifier(s) has changed.

#### Parameters

##### newCanIdentifier

`string`

The new constant CAN identifier.

##### newIdentifierGeneratorType

[`canIdentifierGeneratorType`](../type-aliases/canIdentifierGeneratorType.md)

The new generator type.

##### newMinCanIdentifier

`string`

The new min CAN identifier.

##### newMaxCanIdentifier

`string`

The new max CAN identifier.

##### newIdentifierType

[`canIdentifierType`](../type-aliases/canIdentifierType.md)

#### 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.