Binding Bryntum Gantt data

Bryntum Gantt is a data intensive component that uses several datasets. These datasets usually come from the server and are held in Gantt project during the lifetime of the Gantt view. There are several ways of populating the project data stores.

Using project transport

ProjectModel supports loading and saving of data in multiple stores with transport config. Loading the stores and saving all changes is done in one request.

Configuring project with transport is the simplest way of binding data to the Gantt project stores as seen from the client side, but it does require following a specific protocol on the backend.

The configuration can be as simple as setting the project property like this:

ganttProps: {
    project : {
        loadUrl  : '/server/load/url',
        syncUrl  : '/server/save/url',
        autoLoad : true
    }
}

<BryntumGantt {...ganttProps}/>

With this configuration, the data is loaded and saved from and to the above URLs and the data transport is handled automatically.

Binding existing data to the component

When the application already has a server transport layer then the data for Gantt is available in application code and it needs to be passed (bound) to the component. One approach is to make the data available as component variables and bind them in the Vue template:

App.vue:

<template>
    <bryntum-gantt
        :assignments = "assignments"
        :calendars = "calendars"
        :dependencies = "dependencies"
        :resources = "resources"
        :tasks = "tasks"
        v-bind = "ganttProps"
    />
</template>

<script>
import { ref, reactive } from 'vue';

import { BryntumGantt } from '@bryntum/gantt-vue-3';

import { useGanttProps } from '@/AppConfig';
import * as appData from '@/AppData';

export default {
    name : 'App',

    components : {
        BryntumGantt
    },

    setup() {
        const ganttProps = reactive(useGanttProps());

        const assignments = ref(appData.assignments);
        const calendars = ref(appData.calendars);
        const dependencies = ref(appData.dependencies);
        const resources = ref(appData.resources);
        const tasks = ref(appData.tasks);

        return {
            ganttProps,
            assignments,
            calendars,
            dependencies,
            resources,
            tasks
        };
    }
};
</script>

<style lang = "scss">
@import './App.scss';
</style>

Here we have component variables, initialized by spreading ...initialData. Whenever a change of the data is needed, it is only necessary to assign the new values to these variables, for example:

this.tasks = newTasks;
this.dependencies = newDependencies;

Binding existing data to the project

This approach binds data to a standalone GanttProjectModel and then uses this project in Gantt. Project has its own markup in the template and it must be assigned to the Gantt during initialization.

This approach is suitable for more complex applications that use more than one Bryntum component that share a common project:

App.vue:

<template>
    <div>
        <bryntum-gantt-project-model
            ref = "project"
            :assignments = "assignments"
            :calendars = "calendars"
            :dependencies = "dependencies"
            :resources = "resources"
            :tasks = "tasks"
        />
        <bryntum-gantt
            :project = "project"
            v-bind = "ganttProps"
        />
    </div>
</template>

<script>
import { ref, reactive } from 'vue';

import { BryntumGanttProjectModel, BryntumGantt } from '@bryntum/gantt-vue-3';

import { useGanttProps } from '@/AppConfig';
import * as appData from '@/AppData';

export default {
    name : 'App',

    components : {
        BryntumGanttProjectModel,
        BryntumGantt
    },

    setup() {
        const project = ref(null);

        const ganttProps = reactive(useGanttProps());

        const assignments = ref(appData.assignments);
        const calendars = ref(appData.calendars);
        const dependencies = ref(appData.dependencies);
        const resources = ref(appData.resources);
        const tasks = ref(appData.tasks);

        return {
            project,
            ganttProps,
            assignments,
            dependencies,
            calendars,
            tasks,
            resources
        };
    }
};
</script>

<style lang = "scss">
@import './App.scss';
</style>

Here we create a standalone GanttProjectModel (without any rendered output) with properties bound to individual data sets.

Check implementation in React inline-data demo.