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

# BarcodeData

> - [`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata)
> - [`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready)

## Classes

### BarcodeData

#### Implements

#### Constructors

##### Constructor

```ts
new BarcodeData(rawData?): BarcodeData;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `rawData?` | `string` \| [`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata) |

###### Returns

[`BarcodeData`](#barcodedata)

#### Properties

##### addresses?

```ts
optional addresses?: VCardAddress[] = [];
```

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`addresses`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#addresses)

##### barcodeFormat

```ts
barcodeFormat: BarcodeFormat = BarcodeFormat.QR_CODE;
```

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`barcodeFormat`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#barcodeformat)

##### barcodeSubType

```ts
barcodeSubType: BarcodeSubType = BarcodeSubType.None;
```

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`barcodeSubType`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#barcodesubtype)

##### barcodeValue?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`barcodeValue`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#barcodevalue)

##### data?

```ts
optional data?: string;
```

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`data`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#data)

##### email?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`email`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#email)

##### fax?

```ts
optional fax?: string;
```

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`fax`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#fax)

##### firstName?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`firstName`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#firstname)

##### lastName?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`lastName`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#lastname)

##### mobilePhone?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`mobilePhone`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#mobilephone)

##### organization?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`organization`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#organization)

##### phone?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`phone`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#phone)

##### position?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`position`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#position)

##### url?

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

###### Implementation of

[`IBarcodeData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ibarcodedata).[`url`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#url)

#### Accessors

##### isEmpty

###### Get Signature

```ts
get isEmpty(): boolean;
```

###### Returns

`boolean`

#### Methods

##### equals()

```ts
equals(other): any;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | [`BarcodeData`](#barcodedata) |

###### Returns

`any`

###### Implementation of

[`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#equals)

##### toVCardString()

```ts
toVCardString(): string;
```

###### Returns

`string`

##### fromVCardString()

```ts
static fromVCardString(value): BarcodeData;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

[`BarcodeData`](#barcodedata)

***

### VCardAddress

#### Implements

- [`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress)
- [`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready)

#### Constructors

##### Constructor

```ts
new VCardAddress(address?): VCardAddress;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress) |

###### Returns

[`VCardAddress`](#vcardaddress)

#### Properties

##### address?

```ts
optional address?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`address`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#address)

##### country?

```ts
optional country?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`country`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#country)

##### extendedAddress?

```ts
optional extendedAddress?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`extendedAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#extendedaddress)

##### locality?

```ts
optional locality?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`locality`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#locality)

##### POBox?

```ts
optional POBox?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`POBox`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#pobox)

##### state?

```ts
optional state?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`state`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#state)

##### type?

```ts
optional type?: VCardAddressType[];
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`type`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#type)

##### zipCode?

```ts
optional zipCode?: string;
```

###### Implementation of

[`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress).[`zipCode`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#zipcode)

#### Accessors

##### isEmpty

###### Get Signature

```ts
get isEmpty(): boolean;
```

###### Returns

`boolean`

#### Methods

##### equals()

```ts
equals(other): boolean;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `other` | [`IVCardAddress`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#ivcardaddress) |

###### Returns

`boolean`

###### Implementation of

[`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#equals)

##### toVCardValue()

```ts
toVCardValue(): string[];
```

###### Returns

`string`[]

##### fromVCardValue()

```ts
static fromVCardValue(vCardAddress, meta): VCardAddress;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `vCardAddress` | `string`[] |
| `meta` | [`IAddressMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/IBarcodeData.md#iaddressmetadata) |

###### Returns

[`VCardAddress`](#vcardaddress)