---
title: "BarcodeContentType | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-interfaces/BarcodeContentType/"
---

# BarcodeContentType

> A structure defining the content of empty barcode placeholders.

## Interfaces

### IEmptyBarcodeContent

#### Extended by

- [`IStubBarcodeContent`](#istubbarcodecontent)
- [`ILinearBarcodeContent`](#ilinearbarcodecontent)
- [`IQrVCardBarcodeContent`](#iqrvcardbarcodecontent)
- [`IQrUrlBarcodeContent`](#iqrurlbarcodecontent)
- [`IQrPhoneBarcodeContent`](#iqrphonebarcodecontent)

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |

#### Properties

##### barcodeFormat?

```ts
optional barcodeFormat?: TBarcodeFormat;
```

The barcode format.

##### barcodeSubType?

```ts
optional barcodeSubType?: TBarcodeSubType;
```

The barcode subtype.

***

### ILinearBarcodeContent

A structure defining the content of linear barcodes.

#### Extends

- [`IEmptyBarcodeContent`](#iemptybarcodecontent)\<`TBarcodeFormat`, `TBarcodeSubType`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |

#### Properties

##### barcodeFormat?

```ts
optional barcodeFormat?: TBarcodeFormat;
```

The barcode format.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeFormat`](#barcodeformat)

##### barcodeSubType?

```ts
optional barcodeSubType?: TBarcodeSubType;
```

The barcode subtype.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeSubType`](#barcodesubtype)

##### barcodeValue?

```ts
optional barcodeValue?: string;
```

A value encoded into the barcode.

***

### IQrPhoneBarcodeContent

A structure defining the content of VCard QR codes.

#### Extends

- [`IEmptyBarcodeContent`](#iemptybarcodecontent)\<`TBarcodeFormat`, `TBarcodeSubType`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |

#### Properties

##### barcodeFormat?

```ts
optional barcodeFormat?: TBarcodeFormat;
```

The barcode format.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeFormat`](#barcodeformat)

##### barcodeSubType?

```ts
optional barcodeSubType?: TBarcodeSubType;
```

The barcode subtype.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeSubType`](#barcodesubtype)

##### phone?

```ts
optional phone?: string;
```

A phone number encoded into the QR code.

***

### IQrUrlBarcodeContent

A structure defining the content of URL QR codes.

#### Example

```json
{
   "defaultItemsConfig": {
       "barcode": {
           "barcodeContent": {
                "barcodeFormat": "QrUrl",
                "url": "example.com"
           }
       }
   }
}
```

#### Extends

- [`IEmptyBarcodeContent`](#iemptybarcodecontent)\<`TBarcodeFormat`, `TBarcodeSubType`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |

#### Properties

##### barcodeFormat?

```ts
optional barcodeFormat?: TBarcodeFormat;
```

The barcode format.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeFormat`](#barcodeformat)

##### barcodeSubType?

```ts
optional barcodeSubType?: TBarcodeSubType;
```

The barcode subtype.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeSubType`](#barcodesubtype)

##### url?

```ts
optional url?: string;
```

A URL encoded into the QR code.

***

### IQrVCardBarcodeContent

A structure defining the content of VCard QR codes.

#### Extends

- [`IEmptyBarcodeContent`](#iemptybarcodecontent)\<`TBarcodeFormat`, `TBarcodeSubType`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |

#### Properties

##### barcodeFormat?

```ts
optional barcodeFormat?: TBarcodeFormat;
```

The barcode format.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeFormat`](#barcodeformat)

##### barcodeSubType?

```ts
optional barcodeSubType?: TBarcodeSubType;
```

The barcode subtype.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeSubType`](#barcodesubtype)

##### email?

```ts
optional email?: string;
```

An email address encoded into the QR code.

##### firstName?

```ts
optional firstName?: string;
```

A first name encoded into the QR code.

##### lastName?

```ts
optional lastName?: string;
```

A last name encoded into the QR code.

##### mobilePhone?

```ts
optional mobilePhone?: string;
```

A cell phone number encoded into the QR code.

##### organization?

```ts
optional organization?: string;
```

An organization name encoded into the QR code.

##### phone?

```ts
optional phone?: string;
```

A work phone number encoded into the QR code.

##### position?

```ts
optional position?: string;
```

A job position encoded into the QR code.

##### url?

```ts
optional url?: string;
```

A URL encoded into the QR code.

***

### IStubBarcodeContent

A structure defining the content of stub barcode placeholders.

#### Example

```json
{
   "defaultItemsConfig": {
       "stubImages": {
           "barcode": {
               "postScriptName": "LucidaSans-Italic",
               "text": "Define a Barcode"
           }
       }
   }
}
```

#### Extends

- [`IEmptyBarcodeContent`](#iemptybarcodecontent)\<`TBarcodeFormat`, `TBarcodeSubType`\>

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |

#### Properties

##### barcodeFormat?

```ts
optional barcodeFormat?: TBarcodeFormat;
```

The barcode format.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeFormat`](#barcodeformat)

##### barcodeSubType?

```ts
optional barcodeSubType?: TBarcodeSubType;
```

The barcode subtype.

###### Inherited from

[`IEmptyBarcodeContent`](#iemptybarcodecontent).[`barcodeSubType`](#barcodesubtype)

##### postScriptName?

```ts
optional postScriptName?: string;
```

The font PostScript name of the text message in the stub barcode placeholder.

##### text?

```ts
optional text?: string;
```

The text message in the stub barcode placeholder.

## Type Aliases

### BarcodeContentType

```ts
type BarcodeContentType<TBarcodeFormat, TBarcodeSubType> = 
  | IEmptyBarcodeContent<TBarcodeFormat, TBarcodeSubType>
  | IStubBarcodeContent<TBarcodeFormat, TBarcodeSubType>
  | ILinearBarcodeContent<TBarcodeFormat, TBarcodeSubType>
  | IQrVCardBarcodeContent<TBarcodeFormat, TBarcodeSubType>
  | IQrUrlBarcodeContent<TBarcodeFormat, TBarcodeSubType>
| IQrPhoneBarcodeContent<TBarcodeFormat, TBarcodeSubType>;
```

Info encoded in the barcode.

#### Type Parameters

| Type Parameter |
| ------ |
| `TBarcodeFormat` |
| `TBarcodeSubType` |