JavaScript/jQuery RadioGroup Methods
This section describes the members used to manipulate the UI component.
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the RadioGroup UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxRadioGroup.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the RadioGroup properties
}
});Angular
import RadioGroup from "devextreme/ui/radio_group";
// ...
export class AppComponent {
constructor () {
RadioGroup.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the RadioGroup properties
}
});
}
}Vue
<template>
<div>
<DxRadioGroup id="radioGroup1" />
<DxRadioGroup id="radioGroup2" />
</div>
</template>
<script>
import DxRadioGroup from "devextreme-vue/radio-group";
import RadioGroup from "devextreme/ui/radio_group";
RadioGroup.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the RadioGroup properties
}
});
export default {
components: {
DxRadioGroup
}
}
</script>React
import React, {useEffect} from "react";
import dxRadioGroup from "devextreme/ui/radio_group";
import RadioGroup from "devextreme-react/radio-group";
export default function App() {
useEffect(() => {
dxRadioGroup.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the RadioGroup properties
}
})
});
return (
<div>
<RadioGroup id="radioGroup1" />
<RadioGroup id="radioGroup2" />
</div>
)
}dispose()
Disposes of all the resources allocated to the RadioGroup instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myRadioGroup").dxRadioGroup("dispose");
$("#myRadioGroup").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-radio-group ...
*ngIf="condition">
</dx-radio-group>Vue
<template>
<DxRadioGroup ...
v-if="condition">
</DxRadioGroup>
</template>
<script>
import DxRadioGroup from 'devextreme-vue/radio-group';
export default {
components: {
DxRadioGroup
}
}
</script>React
import React from 'react';
import RadioGroup from 'devextreme-react/radio-group';
function DxRadioGroup(props) {
if (!props.shouldRender) {
return null;
}
return (
<RadioGroup ... >
</RadioGroup>
);
}
class App extends React.Component {
render() {
return (
<DxRadioGroup shouldRender="condition" />
);
}
}
export default App;See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the RadioGroup instance found in an element with the myRadioGroup ID:
// Modular approach
import RadioGroup from "devextreme/ui/radio_group";
...
let element = document.getElementById("myRadioGroup");
let instance = RadioGroup.getInstance(element) as RadioGroup;
// Non-modular approach
let element = document.getElementById("myRadioGroup");
let instance = DevExpress.ui.dxRadioGroup.getInstance(element);See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
option(options)
Updates the values of several properties.
Options with their new values.
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
repaint()
Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)
Resets a property to its default value.
A property's name.