JavaScript/jQuery Splitter Options

See Also

Splitter works with collections of objects or string values.

Depending on your data source, bind Splitter to data as follows.

• Data Array
  Assign the array to the dataSource option.

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#splitterContainer").dxSplitter({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-splitter ...
      [dataSource]="store">
  </dx-splitter>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxSplitterModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxSplitterModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxSplitter ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxSplitter } from 'devextreme-vue/splitter';
  
  export default {
      components: {
          DxSplitter
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import Splitter from 'devextreme-react/splitter';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <Splitter ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the Splitter always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

This property accepts a value of one of the following types:

• Number
  The height in pixels.

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.

The items array can contain:

• Objects with fields described in this section.
• Objects with any other fields. In this case, specify the itemTemplate.

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores supply an API that allows you to update individual items without reassigning the entire item collection.

View Demo

The following code snippet demonstrates itemTemplate usage. Panes have random background colors, and their content includes an order number.

$(() => {
    $("#splitter").dxSplitter({
        items: [
            // ...
        ],
        itemTemplate: function (data, index, element) {
            let randomColor = "#" + Math.floor(Math.random()*16777215).toString(16);
            $(element).css('background-color', randomColor);
            return index + 1;
        }
    });
});

<dx-splitter itemTemplate="item">
    <dxi-item ...></dxi-item>
    <dxi-item ...></dxi-item>
    <div
        *dxTemplate="let data of 'item'; let index = index" 
        [style.background-color]="getRandomColor()"
    >
        {{index + 1}}
    </div>
</dx-splitter>

export class AppComponent {
    constructor() {
        // ...
    }

    getRandomColor() {
        return "#" + Math.floor(Math.random() * 16777215).toString(16);
    }
}

<template>
    <DxSplitter item-template="item">
        <DxItem ... />
        <DxItem ... />
        <template #item="{ data, index }">
            <div :style="{ backgroundColor: getRandomColor() }">{{ index + 1 }}</div>
        </template>
    </DxSplitter>
</template>

<script setup>
import { DxSplitter, DxItem } from "devextreme-vue/splitter";
const getRandomColor = () => {
    return "#" + Math.floor(Math.random() * 16777215).toString(16);
};
</script>

import React from "react";
import Splitter, { Item } from "devextreme-react/splitter";

const itemRender = (data, index) => {
    return (
        <div style={{ backgroundColor: getRandomColor(), height: "100%" }}>
            {index + 1}
        </div>
    );
};

const getRandomColor = () => {
    return "#" + Math.floor(Math.random() * 16777215).toString(16);
};

const App = () => (
    <React.Fragment>
        <Splitter itemRender={itemRender}>
            <Item ... />
            <Item ... />
        </Splitter>
    </React.Fragment>
);

export default App;

See Also

• Custom Templates

<dx-splitter ...
    (onInitialized)="saveInstance($event)">
</dx-splitter>

import { Component } from "@angular/core";
import Splitter from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    splitterInstance: Splitter;
    saveInstance (e) {
        this.splitterInstance = e.component;
    }
}

<template>
    <div>
        <DxSplitter ...
            @initialized="saveInstance">
        </DxSplitter>
    </div>
</template>

<script>
import DxSplitter from 'devextreme-vue/splitter';

export default {
    components: {
        DxSplitter
    },
    data: function() {
        return {
            splitterInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.splitterInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxSplitter ...
            @initialized="saveInstance">
        </DxSplitter>
    </div>
</template>

<script setup>
import DxSplitter from 'devextreme-vue/splitter';

let splitterInstance = null;

const saveInstance = (e) => {
    splitterInstance = e.component;
}
</script>

import Splitter from 'devextreme-react/splitter';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.splitterInstance = e.component;
    }

    render() {
        return (
            <div>
                <Splitter onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

The following code snippet shows how to subscribe to component property changes:

$(function() {
    $("#splitterContainer").dxSplitter({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-splitter ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-splitter>

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

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

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

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

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxSplitterModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxSplitter ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxSplitter from 'devextreme-vue/splitter'; 

export default { 
    components: { 
        DxSplitter
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Splitter from 'devextreme-react/splitter'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Splitter ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

The following image shows horizontal and vertical Splitter orientations:

View Demo

When this property is set to true, the UI component 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.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

Read Guides

This property accepts a value of one of the following types:

• Number
  The width in pixels.

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.