Configuration

An object defining configuration options for the Tooltip widget.

animation

Configures widget visibility animations. This object contains two fields: show and hide.

Type:

Object

Default Value: { show: { type: 'fade', from: 0, to: 1 }, hide: { type: 'fade', to: 0 } }

Show Example:
AngularJS
Knockout
jQuery

buttons

Deprecated

Use the toolbarItems option instead.

Specifies items displayed on the top or bottom toolbar of the popup window.

Type:

Array<Object>

closeOnBackButton

A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button.

Type:

Boolean

Default Value: true

closeOnOutsideClick

A Boolean value specifying whether or not the widget is closed if a user clicks outside of the popover window and outside the target element.

Type:

Boolean

|

function

Function parameters:
event:

Event (jQuery or dxEvent)

The event that caused widget closing. It is a dxEvent or a jQuery.Event when you use jQuery.

Return Value:

Boolean

The required option value.

Default Value: true

The function passed to this option enables you to specify a custom condition for widget closing. For instance, you can prevent closing until a user clicks a certain element.

JavaScript
var widgetOptions = {
    // ...
    closeOnOutsideClick: function(e) {
        return e.target === $("#someElement").get()[0];
    }
}

contentTemplate

A template to be used for rendering widget content.

Type:

template

Function parameters:
contentElement:

Element (jQuery or HTML)

The widget content's container.

Return Value:

String

|

jQuery

A template name or a template container.

Default Value: 'content'

This option enables you to render widget contents depending on field values of the bound data model.

HTML
<div data-options="dxTemplate: { name:'myContent' }">
    <h1 data-bind="text: title"></h1>
    <p>Full name: <span data-bind="text: fullName"></span></p>
</div>
NOTE
A binding context of a content template is the bound view model. So, you can bind template elements to the view model's fields directly (see the code above). To access another binding context within a content template, use the Knockout/AngularJS binding variables.
Show Example:
AngularJS
Knockout
jQuery

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

Type:

Boolean

Default Value: true

If this option is set to true, widget content is rendered when showing the widget. Otherwise, widget content is rendered when rendering the widget.

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

NOTE
For embedded components, the disabled option makes sense only if these components are DevExtreme widgets. In case you want to disable third-party controls, provide a native way to disable interaction. For example, for HTML elements you can use disabled attribute.

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

height

Specifies the widget's height.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget height.

Default Value: 'auto'

This option accepts a value of one of the following types.

  • Number
    The height of the widget in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hideEvent

Specifies options of popover hiding.

Type:

Object

|

String

Default Value: undefined

If you assign only a string that specifies event names on which the widget is hidden, the widget will not apply any delay.

JavaScript
hideEvent: 'dxhoverend'

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

maxHeight

Specifies the maximum height the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The maximum height value.

Default Value: null

The option can hold a value of the following types.

  • numeric - the height in pixels
  • string - a CSS measurement of the height (e.g., "55px", "80%", "auto" and "inherit")
  • function - the function returning the height (e.g., width:function(){ return baseWidth - 10 + "%"; })

maxWidth

Specifies the maximum width the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The maximum width value.

Default Value: null

The option can hold a value of the following types.

  • numeric - the width in pixels
  • string - a CSS measurement of the width (e.g., "55px", "80%", "auto" and "inherit")
  • function - the function returning the width (e.g., width:function(){ return baseWidth - 10 + "%"; })

minHeight

Specifies the minimum height the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The minimum height value.

Default Value: null

The option can hold a value of the following types.

  • numeric - the height in pixels
  • string - a CSS measurement of the height (e.g., "55px", "80%", "auto" and "inherit")
  • function - the function returning the height (e.g., width:function(){ return baseWidth - 10 + "%"; })

minWidth

Specifies the minimum width the widget can reach while resizing.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The minimum width value.

Default Value: null

The option can hold a value of the following types.

  • numeric - the width in pixels
  • string - a CSS measurement of the width (e.g., "55px", "80%", "auto" and "inherit")
  • function - the function returning the width (e.g., width:function(){ return baseWidth - 10 + "%"; })

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onHidden

A handler for the hidden event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

Assign a function to perform a custom action after the widget is hidden.

onHiding

A handler for the hiding event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

cancel:

Boolean

Indicates whether to cancel hiding the overlay.

Default Value: null

Assign a function to perform a custom action before hiding the widget.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

Default Value: null

You cannot access elements in the widget because this handler is executed before they are ready. Use the onContentReady handler instead.

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onShowing

A handler for the showing event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

Assign a function to perform a custom action before showing the widget.

onShown

A handler for the shown event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

Assign a function to perform a custom action after the widget is shown.

position

An object defining widget positioning options.

Default Value: 'bottom'
Accepted Values: 'top' | 'bottom' | 'left' | 'right'

Besides the position configuration object, the option can take on the following string values, which are shortcuts for the corresponding position configuration.

  • 'top' - places the popover over the target element
  • 'bottom' - places the popover under the target element
  • 'left' - places the popover to the left of the target element
  • 'right' - places the popover to the right of the target element
NOTE
To specify the element against which the widget will be positioned, use the target option instead of the of field of the position object. If both target and of are specified, target will be used.
Show Example:
AngularJS
Knockout
jQuery

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

shading

A Boolean value specifying whether or not the main screen is inactive while the widget is active.

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

shadingColor

Specifies the shading color.

Type:

String

Default Value: ''

This option makes sense only if the shading option is set to true.

showEvent

Specifies options for displaying the widget.

Type:

Object

|

String

Default Value: undefined

If you assign only a string that specifies event names on which the widget is shown, the widget will not apply any delay.

JavaScript
showEvent: 'dxclick'

target

The target element associated with a popover.

Type:

String

|

DOM Node

|

jQuery

Specify this option to indicate the element for which the popover will be invoked. This option can take on one of the following values.

JavaScript
//CSS selector
target: '#targetElement';

//jQuery wrapper
target: $('#targetElement');

//DOM element
target: document.getElementById('targetElement');

To align the popover near this element, use the position option.

visible

A Boolean value specifying whether or not the widget is visible.

Type:

Boolean

Default Value: false

You can show and hide the widget by changing the value of an observable variable passed to this option.

width

Specifies the widget's width.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget width.

Default Value: 'auto'

This option accepts a value of one of the following types.

  • Number
    The width of the widget in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }