# GC.Spread.Sheets.GanttSheet.GanttMapping

## Content

# Class: GanttMapping

[Sheets](../modules/GC.Spread.Sheets).[GanttSheet](../modules/GC.Spread.Sheets.GanttSheet).GanttMapping

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.GanttSheet.GanttMapping#constructor)

### Methods

- [formatBoolean](GC.Spread.Sheets.GanttSheet.GanttMapping#formatboolean)
- [formatDate](GC.Spread.Sheets.GanttSheet.GanttMapping#formatdate)
- [formatDuration](GC.Spread.Sheets.GanttSheet.GanttMapping#formatduration)
- [formatInt](GC.Spread.Sheets.GanttSheet.GanttMapping#formatint)
- [formatMode](GC.Spread.Sheets.GanttSheet.GanttMapping#formatmode)
- [parseBoolean](GC.Spread.Sheets.GanttSheet.GanttMapping#parseboolean)
- [parseDate](GC.Spread.Sheets.GanttSheet.GanttMapping#parsedate)
- [parseDuration](GC.Spread.Sheets.GanttSheet.GanttMapping#parseduration)
- [parseInt](GC.Spread.Sheets.GanttSheet.GanttMapping#parseint)
- [parseMode](GC.Spread.Sheets.GanttSheet.GanttMapping#parsemode)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new GanttMapping**()

Creates the mapping for the GanttSheet

**`classdesc`** Represents the mapping of GanttSheet to convert and convert back the task value.

## Methods

### <a id="formatboolean" name="formatboolean"></a> formatBoolean

▸ **formatBoolean**(`value`): `string`

A helper function that will format a boolean value to string.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `boolean` | The boolean value to format. |

#### Returns

`string`

___

### <a id="formatdate" name="formatdate"></a> formatDate

▸ **formatDate**(`value`, `format?`, `culture?`): `string`

A helper function that will format a Date value to string.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `Date` | The Date value to format. |
| `format?` | `string` | - |
| `culture?` | `string` | - |

#### Returns

`string`

___

### <a id="formatduration" name="formatduration"></a> formatDuration

▸ **formatDuration**(`value`): `string`

A helper function that will format a [GC.Spread.Sheets.GanttSheet.Duration](../modules/GC.Spread.Sheets.GanttSheet#duration) value to string.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | [`Duration`](../modules/GC.Spread.Sheets.GanttSheet#duration) | The Duration value to format. |

#### Returns

`string`

___

### <a id="formatint" name="formatint"></a> formatInt

▸ **formatInt**(`value`): `string`

A helper function that will format a number value to string.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `number` | The number value to format. |

#### Returns

`string`

___

### <a id="formatmode" name="formatmode"></a> formatMode

▸ **formatMode**(`value`): `string`

A helper function that will format a [GC.Spread.Sheets.GanttSheet.TaskScheduleMode](../modules/GC.Spread.Sheets.GanttSheet#taskschedulemode) value to string.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | [`TaskScheduleMode`](../modules/GC.Spread.Sheets.GanttSheet#taskschedulemode) | The value to format. |

#### Returns

`string`

___

### <a id="parseboolean" name="parseboolean"></a> parseBoolean

▸ **parseBoolean**(`value`): `boolean`

A helper function that will parse an original value in string or other types to a boolean value.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `any` | The original value to parse. |

#### Returns

`boolean`

___

### <a id="parsedate" name="parsedate"></a> parseDate

▸ **parseDate**(`value`, `format?`, `culture?`): `Date`

A helper function that will parse an original value in string or other types to a Date value.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `any` | The original value to parse. |
| `format?` | `string` | - |
| `culture?` | `string` | - |

#### Returns

`Date`

___

### <a id="parseduration" name="parseduration"></a> parseDuration

▸ **parseDuration**(`value`): [`Duration`](../modules/GC.Spread.Sheets.GanttSheet#duration)

A helper function that will parse an original value in string or other types to a [GC.Spread.Sheets.GanttSheet.Duration](../modules/GC.Spread.Sheets.GanttSheet#duration) value.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `any` | The original value to parse. |

#### Returns

[`Duration`](../modules/GC.Spread.Sheets.GanttSheet#duration)

___

### <a id="parseint" name="parseint"></a> parseInt

▸ **parseInt**(`value`): `number`

A helper function that will parse an original value in string or other types to an integer value.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `any` | The original value to parse. |

#### Returns

`number`

___

### <a id="parsemode" name="parsemode"></a> parseMode

▸ **parseMode**(`value`): [`TaskScheduleMode`](../modules/GC.Spread.Sheets.GanttSheet#taskschedulemode)

A helper function that will parse an original value in string or other types to a [GC.Spread.Sheets.GanttSheet.TaskScheduleMode](../modules/GC.Spread.Sheets.GanttSheet#taskschedulemode) value.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `any` | The original value to parse. |

#### Returns

[`TaskScheduleMode`](../modules/GC.Spread.Sheets.GanttSheet#taskschedulemode)
