# GC.Spread.Sheets.GanttSheet.CustomWorkWeek

## Content

# Class: CustomWorkWeek

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

## Hierarchy

- [`WorkWeek`](GC.Spread.Sheets.GanttSheet.WorkWeek)

  ↳ **`CustomWorkWeek`**

## Table of contents

### Constructors

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

### Properties

- [finish](GC.Spread.Sheets.GanttSheet.CustomWorkWeek#finish)
- [start](GC.Spread.Sheets.GanttSheet.CustomWorkWeek#start)

### Methods

- [getWorkDay](GC.Spread.Sheets.GanttSheet.CustomWorkWeek#getworkday)

## Constructors

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

• **new CustomWorkWeek**(`workDays`, `start`, `finish`)

Creates a new week with the specified work times of each day for a custom date range.

**`classdesc`** Represents the a week in calender, which defines the work times of each day.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `workDays` | [`WorkDay`](../modules/GC.Spread.Sheets.GanttSheet#workday)[] | A workday array with 7 items from Sunday to Saturday, specifies the work times of each day in a week. |
| `start` | `Date` | A date specifies the start of the date range to apply this week definition in calendar. |
| `finish` | `Date` | A date specifies the finish of the date range to apply this week definition in calendar. |

#### Overrides

[WorkWeek](GC.Spread.Sheets.GanttSheet.WorkWeek).[constructor](GC.Spread.Sheets.GanttSheet.WorkWeek#constructor)

## Properties

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

• **finish**: `Date`

Gets or sets the finish date for this custom work week.

___

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

• **start**: `Date`

Gets or sets the start date for this custom work week.

## Methods

### <a id="getworkday" name="getworkday"></a> getWorkDay

▸ **getWorkDay**(`index`): [`WorkDay`](../modules/GC.Spread.Sheets.GanttSheet#workday)

Gets the work times for the specified day in the week.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `index` | `number` | A number from 0 to 6, or a DayOfWeek value indicates the day. |

#### Returns

[`WorkDay`](../modules/GC.Spread.Sheets.GanttSheet#workday)

The work times for the specified day.

#### Inherited from

[WorkWeek](GC.Spread.Sheets.GanttSheet.WorkWeek).[getWorkDay](GC.Spread.Sheets.GanttSheet.WorkWeek#getworkday)