Interface GanttTemplates

Index

Methods

Methods

public api_date(date: Date): string

specifies the format of dates that are set by means of API methods. Used to parse incoming dates

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public date_grid(date: Date): string

specifies the format of dates in the "Start time" column

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public date_scale(date: Date): string

specifies the date format of the time scale (X-Axis)

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public drag_link(from: any, from_start: boolean, to: any, to_start: boolean): string

specifies the text of tooltips that are displayed when the user creates a new dependency link

Parameters

  • from: any

    the id of the source task

  • from_start: boolean

    true, if the link is being dragged from the start of the source task, false - if
    from the end of the task

  • to: any

    the id of the target task( 'null' or 'undefined', if the target task isn't specified yet)

  • to_start: boolean

    true, if the link is being dragged to the start of the target task, false - if
    to the end of the task

Returns

string

public drag_link_class(from: any, from_start: boolean, to: any, to_start: boolean): string

specifies the CSS class that will be applied to the link receiver (pop-up circle near the task bar)

Parameters

  • from: any

    the id of the source task

  • from_start: boolean

    true, if the link is being dragged from the start of the source task, false - if
    from the end of the task

  • to: any

    the id of the target task( 'null' or 'undefined', if the target task isn't specified yet)

  • to_start: boolean

    true, if the link is being dragged to the start of the target task, false - if
    to the end of the task

Returns

string

public grid_blank(task: any): string

specifies the custom content inserted before the labels of child items in the tree column

Parameters

  • task: any

    the task object

Returns

string

public grid_file(task: any): string

specifies the icon of child items in the tree column

Parameters

  • task: any

    the task object

Returns

string

public grid_folder(task: any): string

specifies the icon of parent items in the tree column

Parameters

  • task: any

    the task object

Returns

string

public grid_header_class(column: any, config: string): string

specifies the CSS class that will be applied to the headers of the table's columns

Parameters

  • column: any

    the column's configuration object

  • config: string

    the column's id ('name' attribute)

Returns

string

public grid_indent(task: any): string

specifies the indent of the child items in a branch (in the tree column)

Parameters

  • task: any

    the task object

Returns

string

public grid_open(task: any): string

specifies the icon of the open/close sign in the tree column

Parameters

  • task: any

    the task object

Returns

string

public grid_row_class(start: Date, end: Date, task: any): string

specifies the CSS class that will be applied to a grid row

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public leftside_text(start: Date, end: Date, task: any): string

specifies the text assigned to tasks bars on the left side

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public link_class(link: any): string

specifies the CSS class that will be applied to a link

Parameters

  • link: any

    the link object

Returns

string

public link_description(link: any): string

specifies the text in the header of the link's "delete" confirm window

Parameters

  • link: any

    the link object

Returns

string

public progress_text(start: Date, end: Date, task: any): string

specifies the text in the completed part of the task bar

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public quick_info_content(start: Date, end: Date, task: any): string

specifies the content of the pop-up edit form

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public quick_info_date(start: Date, end: Date, task: any): string

specifies the date of the pop-up edit form

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public quick_info_title(start: Date, end: Date, task: any): string

specifies the title of the pop-up edit form

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public rightside_text(start: Date, end: Date, task: any): string

specifies the text assigned to tasks bars on the right side

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public scale_cell_class(date: Date): string

specifies the CSS class that will be applied to the time scale of the timeline area

Parameters

  • date: Date

    the date of a cell

Returns

string

public task_cell_class(item: Date, date: Date): string

specifies the CSS class that will be applied to the cells of the timeline area

Parameters

  • item: Date

    the task object assigned to the row

  • date: Date

    the date of a cell

Returns

string

public task_class(start: Date, end: Date, task: any): string

specifies the CSS class that will be applied to task bars

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public task_date(date: Date): string

specifies the date format of the label in the 'Time period' section of the lightbox

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public task_row_class(start: Date, end: Date, task: any): string

specifies the CSS class that will be applied to the row of the timeline area

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public task_text(start: Date, end: Date, task: any): string

specifies the text in the task bars and the header of the lightbox

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public task_time(start: Date, end: Date, task: any): string

specifies the date period in the header of the lightbox

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public time_picker(date: Date): string

specifies the format of the drop-down time selector in the lightbox

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public tooltip_date_format(date: Date): string

specifies the format of start and end dates displayed in the tooltip

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public tooltip_text(start: Date, end: Date, task: any): string

specifies the text of tooltips

Parameters

  • start: Date

    the date when a task is scheduled to begin

  • end: Date

    the date when a task is scheduled to be completed

  • task: any

    the task object

Returns

string

public xml_date(date: Date): string

a string from an XML file is converted into a date object in conformity with this template

Parameters

  • date: Date

    the date which needs formatting

Returns

string

public xml_format(date: Date): string

a date object is converted into a string in conformity with this template. Used to send data back to the server

Parameters

  • date: Date

    the date which needs formatting

Returns

string