Skip to main content

Gantt API

Gantt properties

activeTaskOptional. Defines an active task for which the Editor dialog is opened
assignmentsOptional. Defines resource assignments to tasks in Gantt
autoScaleOptional. Allows the timescale to change dynamically its start/end dates
baselinesOptional. Shows or hides tasks baselines
calendarOptional. Sets a global working-time calendar for the Gantt chart
calendarsOptional. Defines a registry of named working-time calendars for tasks and resources
cellBordersOptional. Defines borders style in the Gantt chart
cellHeightOptional. Defines the height of a cell in pixels
cellWidthOptional. Defines the width of a cell in pixels
columnsOptional. An array of objects with configuration parameters for columns in the grid area
criticalPathOptional. Enables critical path calculation and visualization in Gantt
displayModeOptional. Defines which areas of the Gantt chart to display
durationUnitOptional. Defines duration unit for tasks
editorShapeAn array of objects containing settings for managing the appearance and functionality of the Editor dialog
endOptional. Sets the end date of the timescale
gridWidthOptional. Defines the width of the grid area in pixels
groupByOptional. Defines the initial task grouping configuration in Gantt
highlightTimeOptional. Highlights specific time areas in the chart
lengthUnitOptional. Defines the minimal unit for task bars (the task length) in a chart
linksOptional. Defines links between tasks in Gantt
markersDefines visual markers on the timescale
Gantt Properties API. projectEnd | SVAR Vue Gantt DocumentationOptional. Defines the end boundary of the project timeline
projectStartOptional. Defines the start boundary of the project timeline
readonlyOptional. Prevents making changes to the data in Gantt
resourcesOptional. Defines resources in Gantt
rollupsOptional. Shows or hides task rollups on summary tasks
scaleHeightOptional. Defines the height of the header cell in pixels
scalesOptional. Defines the timescale of Gantt
scheduleEnables automatic task scheduling based on end-to-start dependencies
selectedOptional. Marks tasks as selected
slackOptional. Enables float (slack) calculation for a task
splitTasksEnables displaying and editing split tasks
startOptional. Sets the start date of the timescale
summaryOptional. Configures advanced summary task behavior
tasksOptional. Defines tasks in Gantt
taskTemplateOptional. Defines your own template for tasks bars
tasksOptional. An array of objects containing the tasks types data
undoOptional. Enables executing the undo and redo actions
unscheduledTasksAllows displaying and handling unscheduled tasks
wbsEnables Work Breakdown Structure (WBS) numbering in the Gantt grid
zoomEnables zooming in Gantt

Gantt actions

add-assignmentFires when adding a new resource assignment to a task
add-linkFires when adding a link
add-taskFires when adding a new task
copy-taskFires when copying a task
delete-assignmentFires when deleting a resource assignment
delete-linkFires when deleting a link
delete-taskFires when deleting a task
drag-taskFires when dragging a task
export-dataTriggers export of Gantt data to PDF, PNG, Excel, or MS Project XML
filter-tasksFires when filtering tasks
group-tasksFires when grouping tasks by a specified field
hotkeyFires when applying a hotkey
import-dataTriggers import of MS Project XML data to Gantt
indent-taskFires when indenting a task
move-taskFires when moving a task
open-resource-rowFires when a parent resource row is expanded or collapsed in ResourceLoad
open-taskFires when expanding a branch of tasks
provide-dataProvides new data for a branch
redoAllows performing steps forward in history
render-dataFires when data is rendered when scrolling
request-dataFires when data for a task branch is requested
resize-chartFires when the chart container size changes
resize-gridFires when the width of the grid panel changes
schedule-tasksTriggers cascading updates of tasks in auto scheduling mode
scroll-chartFires when a chart is scrolled
select-taskFires when selecting a task
set-display-modeFires when the visible layout of the Gantt chart is switched
show-editorFires when opening the Editor dialog for a task
sort-resourcesFires when the resource grid is sorted
sort-tasksFires when sorting tasks
split-taskSplits a task into multiple segments
undoAllows performing steps back in history
update-assignmentFires when updating a resource assignment
update-linkFires when updating a link
update-taskFires when updating a task
zoom-scaleFires when zooming a chart

Gantt methods

api.detach()Allows removing/detaching action handlers
api.exec()Allows triggering Gantt actions
api.getCalendar()Returns a calendar instance from the registry, or the global calendar
api.getReactiveState()Gets the state object with the reactive properties of Gantt
api.getResourceTasks(id)Gets all tasks assigned to a resource
api.getState()Gets the state object that stores current values of most Gantt properties
api.getStores()Gets an object with the DataStore properties of Gantt
api.getTable()Gets the Table API instance
api.getTask(id)Gets an object with the task configuration
api.getTaskResources(id)Gets all resources assigned to a task
api.intercept()Allows intercepting and blocking/modifying actions
api.on()Allows attaching a handler to the inner events
api.serialize()Serializes and returns the data of the current Gantt configuration
api.setNext()Allows adding some action into the Event Bus order