documentation changes
This commit is contained in:
parent
cb2c84f4d2
commit
7b78d953f1
17
README.md
17
README.md
@ -35,6 +35,21 @@ You may handle actions
|
|||||||
|
|
||||||
## Gantt Configuration
|
## Gantt Configuration
|
||||||
|
|
||||||
- EventOption
|
- **EventOption**
|
||||||
|
|
||||||
|
| Parameter Name | Type | Required | Description |
|
||||||
|
| ---------------- | :-------------------------------- | :------- | :------------------------------------------------------------------------------------ |
|
||||||
|
| onDoubleClick | (task: Task) => any | No | Specifies the function to be executed on the bar`s onDoubleClick event. |
|
||||||
|
| onTaskDelete | (task: Task) => void/Promise<any> | No | Specifies the function to be executed on the bar`s on Delete button press event. |
|
||||||
|
| onDateChange | (task: Task) => void/Promise<any> | No | Specifies the function to be executed when drag bar`s event on timeline has finished. |
|
||||||
|
| onProgressChange | (task: Task) => void/Promise<any> | No | Specifies the function to be executed when drag bar`s progress event has finished |
|
||||||
|
| timeStep | number | No | A time step value for onDateChange. Specify in milliseconds |
|
||||||
|
|
||||||
|
- **DisplayOption**
|
||||||
|
|
||||||
|
| Parameter Name | Type | Required | Description |
|
||||||
|
| -------------- | :----- | :------- | :--------------------------------------------------------------------------------------------- |
|
||||||
|
| viewMode | enum | No | Specifies the time scale. Quarter Day, Half Day, Day, Week(ISO-8601, 1st day is Monday), Month |
|
||||||
|
| locale | string | No | Specifies the month name language. Able formats: ISO 639-2, Java Locale. |
|
||||||
|
|
||||||
Work in progress
|
Work in progress
|
||||||
|
|||||||
@ -39,7 +39,7 @@ export interface EventOption {
|
|||||||
export interface DisplayOption {
|
export interface DisplayOption {
|
||||||
viewMode?: ViewMode;
|
viewMode?: ViewMode;
|
||||||
/**
|
/**
|
||||||
* Display date format. Able formats: ISO 639-2, Java Locale
|
* Specifies the month name language. Able formats: ISO 639-2, Java Locale
|
||||||
*/
|
*/
|
||||||
locale?: string;
|
locale?: string;
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user