JavaScript/jQuery Gantt - toolbar.items

Configures toolbar items' settings.

Type:

The Gantt UI component allows you to add default and create custom toolbar items.

jQuery

JavaScript

$(function () {
    $("#gantt").dxGantt({
        //...
        toolbar: {
            items: [
                'undo',
                'redo',
                'separator',
                {
                    widget: "dxButton",
                    options: {
                        text: "About",
                        icon: "info",
                        stylingMode: "text",
                        onClick: function () {
                            // ...
                        }
                    }
                }
            ]
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-gantt>
    <dxo-toolbar>
        <dxi-item name="undo"></dxi-item>
        <dxi-item name="redo"></dxi-item>
        <dxi-item name="separator"></dxi-item>
        <dxi-item
            widget="dxButton"
            [options]="customButtonOptions">
        </dxi-item>
    </dxo-toolbar>

    <dxi-column dataField="title" caption="Subject" [width]="300"></dxi-column>
    <dxi-column dataField="start" caption="Start Date"></dxi-column>
    <dxi-column dataField="end" caption="End Date"></dxi-column>
</dx-gantt>

import { Component } from '@angular/core';
import { Service } from './app.service';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css'],
    providers: [Service]
})

export class AppComponent {
    constructor(service: Service) {
        this.customButtonOptions = {
            text: 'About',
            icon: 'info',
            stylingMode: 'text',
            onClick: () => {
                // ...
            }
        };
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    imports: [
        BrowserModule,
        DxGanttModule
    ],        
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template>
    <DxGantt>
        <DxToolbar>
            <DxItem name="undo"/>
            <DxItem name="redo"/>
            <DxItem name="separator"/>
            <DxItem
                :options="aboutButtonOptions"
                widget="dxButton"
            />
        </DxToolbar>
    </DxGantt>
</template>
<script>
    import 'devextreme/dist/css/dx.light.css';
    import 'devexpress-gantt/dist/dx-gantt.css'; 

    import { 
        DxGantt, DxToolbar, DxItem
        // ... 
    } from 'devextreme-vue/gantt';

    export default {
        components: { 
            DxGantt, DxToolbar, DxItem
        }
        data() {
            return {
                aboutButtonOptions: {
                    text: 'About',
                    icon: 'info',
                    stylingMode: 'text',
                    onClick: () => {
                        // ...
                    }
                }
            };
        }
    };
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';
import 'devexpress-gantt/dist/dx-gantt.css'; 

import Gantt, { 
    // ... 
} from 'devextreme-react/gantt';

const App = () => {
    const aboutButtonOptions = {
        text: 'About',
        icon: 'info',
        stylingMode: 'text',
        onClick: 'onItemClick'
    };

    const onItemClick = (e) => {
        // ...
    };        

    return (
        <Gantt>
            <Toolbar>
                <Item name="undo" />
                <Item name="redo" />
                <Item name="separator" />
                <Item widget="dxButton" options={this.aboutButtonOptions} />
            </Toolbar>
            {/* ... */}
        </Gantt>
    );
};

export default App;

ASP.NET Core Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .Toolbar(t =>  {
        t.Items(i => {
            i.Add().Name(GanttToolbarItem.Undo);
            i.Add().Name(GanttToolbarItem.Redo);
            i.Add().Name(GanttToolbarItem.Separator);
            i.Add().Name("About")
                .Widget(widget => widget.Button()
                .OnClick("showInfo")
                .Icon("info")
                .Text("About")
                .StylingMode(ButtonStylingMode.Text)
                );

}); }) // ... )

JavaScript

<script type="text/javascript">
    function showInfo() {
        // ...
    }
</script>

ASP.NET MVC Controls

Razor C#

@(Html.DevExtreme().Gantt()
    .Toolbar(t =>  {
        t.Items(i => {
            i.Add().Name(GanttToolbarItem.Undo);
            i.Add().Name(GanttToolbarItem.Redo);
            i.Add().Name(GanttToolbarItem.Separator);
            i.Add().Name("About")
                .Widget(widget => widget.Button()
                .OnClick("showInfo")
                .Icon("info")
                .Text("About")
                .StylingMode(ButtonStylingMode.Text)
                );

}); }) // ... )

JavaScript

<script type="text/javascript">
    function showInfo() {
        // ...
    }
</script>

cssClass

Specifies a CSS class to be applied to the item.

Type:

String

Default Value: undefined

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

html

Specifies the HTML markup to be inserted into the item element.

Type:

String

The Gantt component evaluates the html property's value. This evaluation, however, makes the Gantt potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.

You can use the text property as a safe alternative.

locateInMenu

Specifies when to display an item in the toolbar's overflow menu.

Type:

String

Default Value: 'never'

Accepted Values: 'always' | 'auto' | 'never'

location

Specifies the toolbar item's location.

Type:

String

Default Value: 'before'

Accepted Values: 'after' | 'before' | 'center'

Whatever template you use for UI component items (default or a custom) will be located according to the value specified for the location field in the item data source object.

menuItemTemplate

Specifies a template that should be used to render a menu item.

Type:

template

Template Data: undefined

The following types of the specified value are available.

Assign a string containing the name of the required template.
Assign a jQuery object of the template's container.
Assign a DOM Node of the template's container.
Assign a function that returns the jQuery object or a DOM Node of the template's container.

name

Specifies the toolbar item's name.

Type:

String

options

Configures the DevExtreme UI component used as a toolbar item.

Type: any

Angular

options should contain the properties of the DevExtreme UI component specified in the widget property. Because of this dependency, options cannot be typed and are not implemented as nested configuration components. Specify options with an object.

app.component.html

app.module.ts

<dx-toolbar ... >
    <dxi-item
        widget="dxCheckBox"
        [options]="{ text: 'Show IDs' }">
    </dxi-item>
</dx-toolbar>

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxToolbarModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxToolbarModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

options should contain the properties of the DevExtreme UI component specified in the widget property. Because of this dependency, options cannot be typed and are not implemented as nested configuration components. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.

App.vue

<template>
    <DxToolbar ... >
        <DxItem ...
            widget="dxCheckBox"
            :options="checkBoxOptions"
        />
    </DxToolbar>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxToolbar, {
    DxItem
} from 'devextreme-vue/toolbar';

export default {
    components: {
        DxToolbar,
        DxItem
    },
    data() {
        return {
            checkBoxOptions: { text: 'Show IDs' }
        }
    }
}
</script>

React

options should contain the properties of the DevExtreme UI component specified in the widget property. Because of this dependency, options cannot be typed and are not implemented as nested configuration components. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Toolbar, {
    Item
} from 'devextreme-react/toolbar';

class App extends React.Component {
    checkBoxOptions = { text: 'Show IDs' };

    render() {
        return (
            <Toolbar ... >
                <Item
                    widget="dxCheckBox"
                    options={this.checkBoxOptions}
                />
            </Toolbar>
        );
    }
}
export default App;

NOTE

If you use the Menu UI component as a toolbar item, the adaptivityEnabled property does not apply.

showText

Specifies when to display the text for the UI component item.

Type:

String

Default Value: 'always'

Accepted Values: 'always' | 'inMenu'

The text should be specified in the options configuration object.

NOTE

This property is available only if the widget property's value is "dxButton".

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data:

CollectionWidgetItem

The item object to be rendered.

The following types of the specified value are available.

Assign a string containing the name of the required template.
Assign a jQuery object of the template's container.
Assign a DOM Node of the template's container.
Assign a function that returns the jQuery object or a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.

jQuery

index.js

$(function() {
    $("#ganttContainer").dxGantt({
        // ...
        toolbar: {
            items: [
                {
                    // ...
                    template: '<div>Custom Item</div>'
                }
            ]  
        }           
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-gantt ... >
    <dxo-toolbar>
        <dxi-item ...>
            <div *dxTemplate>
                <div>Custom Item</div>
            </div>
        </dxi-item>
    </dxo-toolbar>
</dx-gantt>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxGanttModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxGanttModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template>
    <DxGantt>
        <DxToolbar>
            <DxItem ...>
                <div>Custom Item</div>
            </DxItem>
        </DxToolbar>
    </DxGantt>
</template>

<script>

import DxGantt, {
    DxToolbar, DxItem
} from 'devextreme-vue/gantt';

export default {
    components: {
        DxGantt,
        DxToolbar,
        DxItem
    },
    // ...
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Gantt, {
    Toolbar, Item
} from 'devextreme-react/gantt';

const renderCustomItem = () => {
    return <div>Custom Item</div>;
}

function App() {
    return (
        <Gantt ... >
            <Toolbar>
                <Item ... 
                    render={renderCustomItem}
                >
                </Item>
            </Toolbar>
        </Gantt>
    );
}
export default App;

text

Specifies text displayed for the UI component item.

Type:

String

visible

Specifies whether or not a UI component item must be displayed.

Type:

Boolean

Default Value: true

widget

A UI component that presents a toolbar item. To configure it, use the options object.

Type:

String

NOTE

Import the specified UI component's module when using DevExtreme modules.

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

JavaScript/jQuery Gantt - toolbar.items

jQuery

Angular

Vue

React

ASP.NET Core Controls

ASP.NET MVC Controls

cssClass

disabled

html

locateInMenu

location

See Also

menuItemTemplate

See Also

name

options

Angular

Vue

React

See Also

showText

template

jQuery

Angular

Vue

React

See Also

text

visible

widget

See Also