Ignite UI™ API Documentation

ui.igTileManager

The igTileManager is a layout control for rendering and managing data into tiles. The tiles are displayed in a responsive grid layout and the control provides corresponding layout configurations for each tile in terms to position (row and column spans) and dimensions (row and column position). The following code snippet demonstrates how to initialize the igTileManager control.

Code Sample

<!doctype html>
<html>
<head>
    <!-- Infragistics Combined CSS -->   
    <link href="css/themes/infragistics/infragistics.theme.css" rel="stylesheet" type="text/css" />
    <link href="css/structure/infragistics.css" rel="stylesheet" type="text/css" />
    <!-- jQuery Core -->
    <script src="js/jquery.js" type="text/javascript"></script>
    <!-- jQuery UI -->
    <script src="js/jquery-ui.js" type="text/javascript"></script>
    <!-- Infragistics Combined Scripts -->
    <script src="js/infragistics.core.js" type="text/javascript"></script>
    <script src="js/infragistics.lob.js" type="text/javascript"></script>
    <script type="text/javascript">
        var dataSource = [
                {
                    name: 'Douglas Crockford', 
                    text: 'Douglas Crockford is an American computer programmer and entrepreneur who is best known for his ongoing involvement in the development of the JavaScript language, for having popularized the data format JSON (JavaScript Object Notation), and for developing various JavaScript related tools such as JSLint and JSMin. He is currently a senior JavaScript architect at PayPal, and is also a writer and speaker on JavaScript, JSON, and related web technologies such as the Yahoo! User Interface Library (YUI).',
                    skills: [
                        {description: 'JavaScript'},
                        {description: 'JSON'},
                        {description: 'HTML'},
                        {description: 'JSLint'}
                    ],
                    picture: 'http://www.caloni.com.br/blog/wp-content/uploads/crockford.png', 
                    linkedin: 'http://www.linkedin.com/groups?gid=3165057&trk=group-name'
                },
                {
                    name: 'John Resig',
                    text: 'John Resig is the Dean of Computer Science at Khan Academy and the creator of the jQuery JavaScript library. He\'s also the author of the books Pro JavaScript Techniques and Secrets of the JavaScript Ninja. Currently, John is located in Brooklyn, NY and enjoys studying Ukiyo-e (Japanese Woodblock Printing) in his spare time.',
                    skills: [
                        {description: 'JavaScript'},
                        {description: 'JSON'},
                        {description: 'HTML'},
                        {description: 'jQuery'}
                    ],
                    picture: 'http://4.bp.blogspot.com/-0lrkys7OhZk/TZpreRxfdRI/AAAAAAAAATw/p5wLKETGAV8/s640/John_Resig-1-2.jpg',
                    linkedin: 'http://www.linkedin.com/groups?viewMembers=&gid=100943&sik=1360507269893&goback=%2Eanp_100943_1360507269892_1'
                },
                {
                    name: 'Bill Gates',
                    text: 'William Henry "Bill" Gates III (born October 28, 1955) is an American programmer, inventor, business magnate and philanthropist. Gates is the former chief executive and current chairman of Microsoft, the world\'s largest personal-computer software company, which he co-founded with Paul Allen. He is consistently ranked among the world\'s wealthiest people and was the wealthiest overall from 1995 to 2009, excluding 2008, when he was ranked third; in 2011 he was the wealthiest American and the second wealthiest person. During his career at Microsoft, Gates held the positions of CEO and chief software architect, and remains the largest individual shareholder, with 6.4 percent of the common stock. He has also authored and co-authored several books.',
                    skills: [
                        {description: 'Entrepreneurship'},
                        {description: 'VB'},
                        {description: 'Operating Systems'},
                        {description: 'Programming Languages'}
                    ],
                    picture: 'https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcTsQmMNuOjP0IQwB-i_zomFPeFuIuIk8bhetuZdecvi9RtJ34-g',
                    linkedin: 'http://www.linkedin.com/company/8736?trk=tyah'
                },
                {
                    name: 'Jon Skeet', 
                    text: 'Author of C# in Depth. Currently a software engineer at Google, London. Usually a Microsoft MVP (C#, 2003-2010, 2011-)',
                    skills: [
                       { description: 'C#' },
                       { description: '.NET' },
                       { description: 'Java' }
                    ],
                    picture: 'http://www.dnrtv.com/dnr_photos/JonSkeet.jpg',
                    linkedin: 'uk.linkedin.com/pub/jon-skeet/0/800/ba3'
                }
            ]; 
 
        $(function () {
            $('#dashboard').igTileManager({
              columnWidth: '50%',
              columnHeight: '50%',
              marginLeft: 10,
              marginTop: 10,
              height: 1000,
              width : 600,
              dataSource: dataSource,
              minimizedState: '<h3>${name}</h3><img src="${picture}" title="${name}" alt="error" />',
              maximizedState: '<h3>${name}</h3><img src="${picture}" title="${name}" alt="error" /><p>${text}</p>' +
                '<div style="clear: both">Skills:</div>' +
                '<ul>{{each ${skills} }}<li>${skills.description}</li>{{/each}}</ul>' +
                '<div>LinkedIn: <a href="${linkedin}" target="_blank">http://www.linkedin.com/profile</a></div>'
            });
        });
    </script>
</head>
<body>
    <div id="dashboard"></div>
</body>
</html>

Related Samples

animationDuration

Type:: number
Default:: 500

Gets/Sets the duration of the animations in the tile manager.

Code Sample

//Initialize
$(".selector").igTileManager({
    animationDuration : 1000
    });
 
//Get
var animationDuration = $(".selector").igTileManager("option", "animationDuration");
 
//Set
$(".selector").igTileManager("option", "animationDuration", 1000);

cols

Type:

enumeration

Default:

null
Gets/Sets the columns count in the container.
Members
- null
- Type:object
- The column count will be automatically calculated.
- number
- Type:number
- The column count can be set as a number.
Code Sample

//Initialize
$('.selector').igTileManager({
cols: 5
});
//Get
var cols = igTileManager("option", "cols");
//Set
$igTileManager("option", "cols", 5);
columnHeight

Type:

enumeration

Default:

null
Gets/Sets the height of each column in the container.
Members
- string
- Type:string
- The column height can be set in pixels (px), percentage (%) or asterisk (*) which will distribute all the height between all the columns equally.
- number
- Type:number
- The column height can be set as a number representing value in pixels.
- array
- Type:array
- The column height can be set as an array, specifying height for each column. If more than one column has an asterisk value, the remaining height will be equally distributed between these columns.
- null
- Type:object
- The column height will be calculated based on the container height and the other options.
Code Sample

//Initialize
$('.selector').igTileManager({
columnHeight: 150
});
//Get
var columnHeight = igTileManager("option", "columnHeight");
//Set
$igTileManager("option", "columnHeight", 150);
columnWidth

Type:

enumeration

Default:

null
Gets/Sets the width of each column in the container.
Members
- string
- Type:string
- The column width can be set in pixels (px), percentage (%) or asterisk (*) which will distribute all the width between all the columns equally.
- number
- Type:number
- The column width can be set as a number representing value in pixels.
- array
- Type:array
- The column width can be set as an array, specifying width for each column. If more than one column has an asterisk value, the remaining width will be equally distributed between these columns.
- null
- Type:object
- The column width will be calculated based on the container width and the other options.
Code Sample

//Initialize
$('.selector').igTileManager({
columnWidth: 150
});
//Get
var columnWidth = igTileManager("option", "columnWidth");
//Set
$igTileManager("option", "columnWidth", 150);

dataSource

Type:: object
Default:: null

Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself.

Code Sample

//Initialize
$(".selector").igTileManager({
    dataSource : data
});
 
//Get
var data = $(".selector").igTileManager("option", "dataSource");
 
//Set
var dataSource = data;
$(".selector").igTileManager("option", "dataSource", dataSource);

dataSourceType

Type:: string
Default:: null

Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource type and its type property.

Code Sample

//Initialize
$(".selector").igTileManager({
    dataSourceType : "xml"
});
 
//Get
var type = $(".selector").igTileManager("option", "dataSourceType");
 
//Set
var type = "xml";
$(".selector").igTileManager("option", "dataSourceType", type);

dataSourceUrl

Type:: string
Default:: null

Specifies a remote URL accepted by $.ig.DataSource in order to request data from it.

Code Sample

//Initialize
$(".selector").igTileManager({
    dataSourceUrl : "data.svc"
});
 
//Get
var url = $(".selector").igTileManager("option", "dataSourceUrl");
 
//Set
var url = "data.svc";
$(".selector").igTileManager("option", "dataSourceUrl", url);

height

Type:

enumeration

Default:

null
Gets/Sets the height of the container.
Members
- string
- Type:string
- The height width can be set in pixels (px) and percentage (%).
- number
- Type:number
- The height width can be set as a number in pixels.
- null
- Type:object
- The height width can be set as a number in pixels.
Code Sample

//Initialize
$(".selector").igTileManager({
height : 400
});
//Get
var height = $(".selector").igTileManager("option", "height");
//Set
$(".selector").igTileManager("option", "height", 400);

items

Type:: enumeration
Default:: null

Gets/Sets the tiles configurations. Every tile is described by rowSpan, colSpan, rowIndex and colIndex.

Members

array
Type:object
An array with colSpan, rowSpan, colIndex, rowIndex configurations for each tile.
null
Type:object
Default tile configurations of rowSpan: 1 and colSpan: 1 will be used.

Code Sample

//Initialize
$('.selector').igTileManager({
        items: [{ colSpan: 1, rowSpan: 1, colIndex: 0, rowIndex: 0 },
                { colSpan: 2, rowSpan: 1, colIndex: 1, rowIndex: 0 },
                { colSpan: 3, rowSpan: 2, colIndex: 0, rowIndex: 1 },
                { colSpan: 3, rowSpan: 1, colIndex: 0, rowIndex: 3 }]
});
//Get
var items = igTileManager("option", "items");
//Set
//Items configuration can be set when the new configuration matches the number of items in the old configuration
var items = [{ colSpan: 1, rowSpan: 1, colIndex: 0, rowIndex: 0 },
                { colSpan: 2, rowSpan: 1, colIndex: 1, rowIndex: 0 },
                { colSpan: 3, rowSpan: 2, colIndex: 0, rowIndex: 1 },
                { colSpan: 3, rowSpan: 1, colIndex: 0, rowIndex: 3 }];
$('.selector').igTileManager("option", "items", items);

language
Inherited

Type:: string
Default:: "en"

Set/Get the locale language setting for the widget.

Code Sample

    //Initialize
$(".selector").igTileManager({
    language: "ja"
});
 
// Get
var language = $(".selector").igTileManager("option", "language");
 
// Set
$(".selector").igTileManager("option", "language", "ja");

locale
Inherited

Type:: object
Default:: null

Set/Get the locale setting for the widget.

Code Sample

    //Initialize
$(".selector").igTileManager({
    locale: {}
});
 
// Get
var locale = $(".selector").igTileManager("option", "locale");
 
// Set
$(".selector").igTileManager("option", "locale", {});

marginLeft

Type:: number
Default:: 0

Gets/Sets the horizontal spacing between tiles.

number The horizontal spacing between tiles can be set as a number.

Code Sample

//Initialize
$(".selector").igTileManager({
    marginLeft : 15
});
 
//Get
var marginLeft = $(".selector").igTileManager("option", "marginLeft");
 
//Set
$(".selector").igTileManager("option", "marginLeft", 15);

marginTop

Type:: number
Default:: 0

Gets/Sets the vertical spacing between tiles.

number The vertical spacing between tiles can be set as a number.

Code Sample

//Initialize
$(".selector").igTileManager({
    marginTop : 15
});
 
//Get
var marginTop = $(".selector").igTileManager("option", "marginTop");
 
//Set
$(".selector").igTileManager("option", "marginTop", 15);

maximizedState

Type:: enumeration
Default:: null

Gets/Sets the content of the tiles in maximized state.

Members

string
Type:string
When initializing on html markup provide jQuery selector specifying which elements of the tile to be shown in maximized state. When initializing on data source provide igTemplate that will be rendered for the maximized state.
null
Type:object
The whole content of the tile will be visible in maximized state.

Code Sample

//Initialize
$('.selector').igTileManager({
    maximizedState : 'div'
});
//Get
var maximizedState = $('.selector').igTileManager("option", "maximizedState");
//Set
var maximizedState = 'div';
$('.selector').igTileManager("option", "maximizedState", maximizedState);

maximizedTileIndex

Type:: enumeration
Default:: null

Gets/Sets the index of which items configuration will be used for positioning and sizing of the maximized tile.

Members

number
Type:number
The maximizedTileindex can be set as a number.
null
Type:object
Option is ignored.

Code Sample

//Initialize
$('.selector').igTileManager({
        items: [{ colSpan: 1, rowSpan: 1, colIndex: 0, rowIndex: 0 },
            { colSpan: 2, rowSpan: 1, colIndex: 1, rowIndex: 0 },
            { colSpan: 3, rowSpan: 2, colIndex: 0, rowIndex: 1 },
            { colSpan: 3, rowSpan: 1, colIndex: 0, rowIndex: 3 }],
        maximizedTileIndex: 2
});
//Get
var maximizedTileIndex = $('.selector').igTileManager("option", "maximizedTileIndex");
//Set
var index = 1;
$('.selector').igTileManager("option", "maximizedTileIndex", index);

minimizedState

Type:: enumeration
Default:: null

Gets/Sets the content of the tiles in minimized state.

Members

string
Type:string
When initializing on html markup provide jQuery selector specifying what content of the tile to be shown in minimized state. When initializing on data source provide igTemplate that will be rendered for the minimized state.
null
Type:object
The whole content of the tile will be visible in minimized state.

Code Sample

//Initialize
$('.selector').igTileManager({
    minimizedState : 'h1'
});
//Get
var minimizedState = $('.selector').igTileManager("option", "minimizedState");
//Set
var minimizedState = 'h1';
$('.selector').igTileManager("option", "minimizedState", minimizedState);

preventMaximizingSelector

Type:: string
Default:: "a, input"

Gets/Sets JQuery selector that specifies which elements will not trigger maximizing when clicked on.

Code Sample

//Initialize
$('.selector').igTileManager({
    preventMaximizingSelector : 'a, input'
});
 
//Get
var selector = $('.selector').igTileManager("option", "preventMaximizingSelector");
 
//Set
var selector = 'a, input';
$('.selector').igTileManager("option", "preventMaximizingSelector", selector);

rearrangeItems

Type:: bool
Default:: true

Gets/Sets whether the items will rearrange when the container is resized.

Code Sample

//Initialize
$(".selector").igTileManager({
    rearrangeItems : false
});
 
//Get
var rearrangeItems = $(".selector").igTileManager("option", "rearrangeItems");
 
//Set
$(".selector").igTileManager("option", "rearrangeItems", false);

regional
Inherited

Type:: enumeration
Default:: defaults

Set/Get the regional setting for the widget.

Code Sample

//Initialize
$(".selector").igTileManager({
    regional: "ja"
});
// Get
var regional = $(".selector").igTileManager("option", "regional");
// Set
$(".selector").igTileManager("option", "regional", "ja");

requestType

Type:: string
Default:: "GET"

Specifies the HTTP request method.

Code Sample

//Initialize
$(".selector").igTileManager({
        requestType : "get"
});
 
//Get
var requestType = $('.selector').igTileManager("option", "requestType");
 
//Set
var requestType = "get";
$('.selector').igTileManager("option", "requestType", requestType);

responseContentType

Type:: string
Default:: null

Gets/Sets the HTTP content type for the response object. See Perform an asynchronous HTTP (Ajax) request.

Code Sample

//Initialize
$(".selector").igTileManager({
    responseContentType : 'application/x-www-form-urlencoded; charset=UTF-8'
)};
 
//Get
var respContentType = $('.selector').igTileManager("option", "responseContentType");
 
//Set
var respContentType = 'application/x-www-form-urlencoded; charset=UTF-8';
$('.selector').igTileManager("option", "responseContentType", respContentType);

responseDataKey

Type:: enumeration
Default:: null

Property in the response which specifies where the data records array will be held (if the response is wrapped). See $.ig.DataSource responseDataKey.

Members

string
Type:string
Specifies the name of the property in which data records are held if the response is wrapped.
null
Type:object
Option is ignored.

Code Sample

//Initialize
$('.selector').igTileManager({
    responseDataKey : "d.results"
});
//Get
var responseDataKey = $('.selector').igTileManager("option", "responseDataKey");
//Set
var responseDataKey = "d.results";
$('.selector').igTileManager("option", "responseDataKey", responseDataKey);

responseDataType

Type:: enumeration
Default:: null

Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource type and its type property.

Members

string
Type:string
Explicitly set data source type (such as "json"). Please refer to the documentation of $.ig.DataSource and its type property.
null
Type:object
Option is ignored.

Code Sample

//Initialize
$('.selector').igTileManager({
    responseDataType : "json"
});
//Get
var responseDataType = $('.selector').igTileManager("option", "responseDataType");
//Set
var responseDataType = "json";
$('.selector').igTileManager("option", "responseDataType", responseDataType);

rightPanelCols

Type:: enumeration
Default:: 1

Gets/Sets how many columns to be displayed in the right panel when the tiles are minimized.

Members

number
Type:number
Set the number of right panel columns as a number. The minimum value is 1.
null
Type:object
Default of 1 column will be used.

Code Sample

//Initialize
$('.selector').igTileManager({
    rightPanelCols: 2
});
//Get
var cols = $('.selector').igTileManager("option", "rightPanelCols");
//Set
var cols = 2;
$('.selector').igTileManager("option", "rightPanelCols", cols);

rightPanelTilesHeight

Type:: enumeration
Default:: null

Gets/Sets the height of the minimized tiles in the right panel.

Members

number
Type:number
Set the height of the minimized tiles as a number.
null
Type:object
Default value equal to the column height will be used.

Code Sample

//Initialize
$('.selector').igTileManager({
    rightPanelTilesHeight: 100
});
//Get
var height = $('.selector').igTileManager("option", "rightPanelTilesHeight");
//Set
var height = 100;
$('.selector').igTileManager("option", "rightPanelTilesHeight", height);

rightPanelTilesWidth

Type:: enumeration
Default:: null

Gets/Sets the width of the minimized tiles in the right panel.

Members

number
Type:number
Set the width of the minimized tiles as a number.
null
Type:object
Default value equal to the column width will be used.

Code Sample

//Initialize
$('.selector').igTileManager({
    rightPanelTilesWidth: 100
});
//Get
var width = $('.selector').igTileManager("option", "rightPanelTilesWidth");
//Set
var width = 100;
$('.selector').igTileManager("option", "rightPanelTilesWidth", width);

rows

Type:

enumeration

Default:

null
Gets/Sets the rows count in the container.
Members
- number
- Type:number
- The row count can be set as a number.
- null
- Type:object
- The row count will be automatically calculated.
Code Sample

//Initialize
$('.selector').igTileManager({
rows: 5
});
//Get
var rows = $('.selector').igTileManager("option", "rows");
//Set
var rows = 5;
$('.selector').igTileManager("option", "rows", rows);

showRightPanelScroll

Type:: bool
Default:: true

Gets/Sets whether the right panel should show scrollbar when tiles are overflowing.

Code Sample

//Initialize
$('.selector').igTileManager({
    showRightPanelScroll: true
});
 
//Get
var showRightScroll = $('.selector').igTileManager("option", "showRightPanelScroll");
 
//Set
var showRightScroll = true;
$('.selector').igTileManager("option", "rightPanelTilesWidth", showRightScroll);

splitterOptions

Type:: object
Default:: {}

Configure the container variable representation, which defines splitter functionality.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
        enabled: true,
        collapsed: false,
        collapsible: true
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
 
//Set
var splitterOptions = { enabled : false };
$(".selector").igTileManager("option", "splitterOptions", splitterOptions);

collapsed

Type:: bool
Default:: false

Gets whether the splitter should be initially collapsed.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
        collapsed: true
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
splitterOptions.collapsed;

collapsible

Type:: bool
Default:: false

Gets whether the splitter can be collapsible.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
        collapsible: true
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
splitterOptions.collapsible;

enabled

Type:: bool
Default:: true

Gets/Sets whether the splitter should be enabled.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
        enabled: true
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
splitterOptions.enabled;
 
//Set
var splitterOptions = { enabled : false };
$(".selector").igTileManager("option", "splitterOptions", splitterOptions);

events

Type:: object
Default:: {}

Gets/Sets splitter events.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
        events: {
            collapsed: function(evt, ui) {
                //return reference to igSplitter
                ui.owner;
                // return index of collapsed panel
                ui.index;
            },
            expanded: function (evt, ui) {
                //return reference to igSplitter
                ui.owner;
                // return index of expanded panel
                ui.index;
            }
        }
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
splitterOptions.events;
 
//Set
var splitterOptions = {
    events : {
        collapsed: function(evt, ui) {...},
        expanded: function (evt, ui) {...}
    }
}
$(".selector").igTileManager("option", "splitterOptions", splitterOptions);

collapsed

Type:: object
Default:: null

Event fired after collapsing is performed. Not cancellable.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the splitter instance.
Use ui.index to get an index of collased panel.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
        events: {
            collapsed: function(evt, ui) {
                //return reference to igSplitter
                ui.owner;
                // return index of collapsed panel
                ui.index;
            }
        }
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
splitterOptions.events.collapsed;
 
//Set
var splitterOptions = {
    events : {
        collapsed: function(evt, ui) {...}
    }
}
$(".selector").igTileManager("option", "splitterOptions", splitterOptions);

expanded

Type:: object
Default:: null

Event fired after expanding is performed. Not cancellable.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the splitter instance.
Use ui.index to get an index of expanded panel.

Code Sample

//Initialize
$('.selector').igTileManager({
    splitterOptions: {
            events: {
                expanded: function (evt, ui) {
                //return reference to igSplitter
                ui.owner;
                // return index of expanded panel
                ui.index;
            }
        }
    }
});
 
//Get
var splitterOptions = $(".selector").igTileManager("option", "splitterOptions");
splitterOptions.events.expanded;
 
//Set
var splitterOptions = {
    events : {
        expanded: function (evt, ui) {...}
    }
}
$(".selector").igTileManager("option", "splitterOptions", splitterOptions);

width

Type:

enumeration

Default:

null
.
Members
- string
- Type:string
- The container width can be set in pixels (px) and percentage (%).
- number
- Type:number
- The container width can be set as a number in pixels.
Code Sample

//Initialize
$('.selector').igTileManager({
width: 300
});
//Get
var width = $('.selector').igTileManager("option", "width");
//Set
$('.selector').igTileManager("option", "width", 300);

For more information on how to interact with the Ignite UI controls' events, refer to
Using Events in Ignite UI.

Note: Calling API methods programmatically does not raise events related to their operation unless specifically stated otherwise by the corresponding API documentation; those events are only raised by their respective user interaction.

Show Details

dataBinding

Cancellable:: true

Fired before databinding is performed

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing databinding.
Use ui.dataSource to get a reference to the $.ig.DataSource the tile manager is to be databound to.

Code Sample

//Bind after initialization
$(document).on("igtilemanagerdatabinding", ".selector", function (evt, ui) {
    // reference to igTileManager
    ui.owner;
    //reference to dataSource
    ui.dataSource;
});
 
//Initialize
$(".selector").igTileManager({
    dataBinding: function(evt, ui) {...}
});

dataBound

Cancellable:: false

Fired after databinding is complete

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing databinding.
Use ui.dataView to get a reference to the data the tile manager is databound to.
Use ui.success to get see if the databinding was performed correctly.
Use ui.errorMessage to get the error message if the databinding failed.

Code Sample

//Bind after initialization
$(document).on("igtilemanagerdatabound", ".selector", function (evt, ui) {
    // reference to igTilemanager
    ui.owner;
    // reference to the data the tile has been databound to.
    ui.dataView;
});
 
//Initialize
$(".selector").igTileManager({
    dataBound: function(evt, ui) {...}
});

rendered

Cancellable:: false

Fired after rendering of the tile manager completes.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing rendering.

Code Sample

//Bind after initialization
$(document).on("igtilemanagerrendered", ".selector", function (evt, ui) {
    // reference to the tile.
    ui.owner;
});
 
//Initialize
$(".selector").igTileManager({
    rendered: function(evt, ui) {...}
});

rendering

Cancellable:: true

Fired before rendering of the tile manager begins.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing rendering.
Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided.
Use ui.items to get a reference to the item configurations the tile manager has.

Code Sample

//Bind after initialization
$(document).on("igtilemanagerrendering", ".selector", function (evt, ui) {
    //reference to the tile.
    ui.owner;
    //reference to tiles
    ui.tiles;
    //reference to items
    ui.items;
});
 
//Initialize
$(".selector").igTileManager({
    rendering: function(evt, ui) {...}
});

tileMaximized

Cancellable:: false

Fired after a tile in the tile manager is maximized.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager the maximized tile belongs to.
Use ui.tile to get the jQuery element of the maximized tile.

Code Sample

//Bind after initialization
$(document).on("igtilemanagertilemaximized", ".selector", function (evt, ui) {
    //reference to the widget.
    ui.owner;
    //reference to the maximized tile
    ui.tile;
});
 
//Initialize
$(".selector").igTileManager({
    tileMaximized: function(evt, ui) {...}
});

tileMaximizing

Cancellable:: true

Fired before a tile in the tile manager is maximized.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to.
Use ui.tile to get the jQuery element of the tile being maximized
Use ui.minimizingTile to get reference to the tile that is minimizing simultaneously or null if no tile is minimizing.

Code Sample

//Bind after initialization
$(document).on("igtilemanagertilemaximizing", ".selector", function (evt, ui) {
    //reference to the widget.
    ui.owner;
    //reference to the tile that is going to be maximized.
    ui.tile;
    //reference to the tile that is going to be minimized or null if not any
    ui.minimizingTile;
});
 
//Initialize
$(".selector").igTileManager({
    tileMaximizing: function(evt, ui) {...}
});

tileMinimized

Cancellable:: false

Fired after a tile in the tile manager is minimized.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager the minimized tile belongs to.
Use ui.tile to get the jQuery element of the minimized tile.

Code Sample

//Bind after initialization
$(document).on("igtilemanagertileminimized", ".selector", function (evt, ui) {
    //reference to the widget
    ui.owner;
    //reference to the tile that was minimized
    ui.tile;
});
 
//Initialize
$(".selector").igTileManager({
    tileMinimized: function(evt, ui) {...}
});

tileMinimizing

Cancellable:: true

Fired before a tile in the tile manager is minimized.

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to.
Use ui.tile to get the jQuery element of the tile being minimized
Use ui.maximizingTile to get reference to the tile that is maximizing simultaneously or null if no tile is maximizing.

Code Sample

//Bind after initialization
$(document).on("igtilemanagertileminimizing", ".selector", function (evt, ui) {
    //reference to the widget.
    ui.owner;
    //reference to the tile that is going to be minimized
    ui.tile;
    //reference to the tile that is going to be maximized or null if not any
    ui.maximizingTile;
});
 
//Initialize
$(".selector").igTileManager({
    tileMinimizing: function(evt, ui) {...}
});

tileRendered

Cancellable:: false

Event Fired after a tile has been rendered in the container

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing rendering.
Use ui.tile to get a reference to the rendered tile.

Code Sample

//Bind after initialization
$(document).on("igtilemanagertilerendered", ".selector", function (evt, ui) {
    //reference to the widget.
    ui.owner;
    //reference to the tile
    ui.tile;
});
 
//Initialize
$(".selector").igTileManager({
    tileRendered: function(evt, ui) {...}
});

tileRendering

Cancellable:: true

Event fired before a tile is rendered in the container

Function takes arguments evt and ui.
Use ui.owner to get a reference to the tile manager performing rendering.
Use ui.tile to get a reference to the tile being rendered.

Code Sample

//Bind after initialization
$(document).on("igtilemanagertilerendering", ".selector", function (evt, ui) {
    //reference to the widget
    ui.owner;
    //reference to the tile.
    ui.tile;
});
 
//Initialize
$(".selector").igTileManager({
    tileRendering: function(evt, ui) {...}
});

Show Details

changeGlobalLanguage
Inherited

.igTileManager( "changeGlobalLanguage" );
Changes the widget language to global language. Global language is the value in $.ig.util.language.
Code Sample

$(".selector").igTileManager("changeGlobalLanguage");
changeGlobalRegional
Inherited

.igTileManager( "changeGlobalRegional" );
Changes the widget regional settins to global regional settings. Global regional settings are container in $.ig.util.regional.
Code Sample

$(".selector").igTileManager("changeGlobalRegional");
changeLocale
Inherited

.igTileManager( "changeLocale", $container:object );
Changes the all locales contained into a specified container to the language specified in options.language
Note that this method is for rare scenarios, use language or locale option setter.
- $container
- Type:object
- Optional parameter - if not set it would use the element of the widget as $container.
Code Sample

$(".selector").igTileManager("changeLocale");
dataBind

.igTileManager( "dataBind" );
Causes the TileManager to data bind to the data source (local or remote) , and re-render all of the data as well.
Code Sample

$(".selector").igTileManager("dataBind");
destroy

.igTileManager( "destroy" );

Return Type:

object
Deletes the widget instance (client object). It is no longer accessible and all its event handlers stop working. Destroys all child widgets. Removes auto-generated HTML content, which is outside the widget, e.g. detached popups, dropdowns, etc.
Code Sample

$(".selector").igTileManager("destroy");
layoutManager

.igTileManager( "layoutManager" );

Return Type:

object

Return Type Description:

Returns the layout manager associated with this tile manager.
Returns the layout manager associated with current tile manager.
Code Sample

$(".selector").igTileManager("layoutManager");
maximize

.igTileManager( "maximize", $tileToMaximize:object, [animDuration:number], [event:object] );
Maximizes a given tile.
- $tileToMaximize
- Type:object
- Specifies the jQuery object of the tile element to be maximized.
- animDuration
- Type:number
- Optional
- Specifies the animation duration for this maximizing.
- event
- Type:object
- Optional
- Indicates the browser even which triggered this action (not API).
Code Sample

$(".selector").igTileManager("maximize", tileToMaximize, event);
maximizedTile

.igTileManager( "maximizedTile" );

Return Type:

enumeration

Return Type Description:

Can return 'object|null'. Returns the maximized tile or null if such is not present.
Returns the maximized tile or null if such is not present.
Code Sample

$(".selector").igTileManager("maximizedTile");
minimize

.igTileManager( "minimize", [animDuration:number], [event:object] );
Minimizes the maximized tile. Has no effect if no maximized tile is present.
- animDuration
- Type:number
- Optional
- Specifies the animation duration for this minimize.
- event
- Type:object
- Optional
- Indicates the browser even which triggered this action (not API).
Code Sample

$(".selector").igTileManager("minimize", event);
minimizedTiles

.igTileManager( "minimizedTiles" );

Return Type:

enumeration

Return Type Description:

Can return 'object|null'. Returns an array with the tiles in minimized state or null if such are not present.
Returns an array with the tiles in minimized state or null if such are not present.
Code Sample

$(".selector").igTileManager("minimizedTiles");
reflow

.igTileManager( "reflow", [forceReflow:object], [animationDuration:number], [event:object] );
Reflow the tile manager. Rearranging the tiles to fit in the container.
- forceReflow
- Type:object
- Optional
- Indicates whether the reflow should be forced. Useful in cases where the items size and position was changed manually.
- animationDuration
- Type:number
- Optional
- The animation duration to be used for this reflow only.
- event
- Type:object
- Optional
- Indicates the browser even which triggered this action (not API).
Code Sample

$('.selector').igTileManager("reflow", forceReflow, event);
splitter

.igTileManager( "splitter" );

Return Type:

enumeration

Return Type Description:

Can return 'object|null'. Returns the splitter associated with this tile manager or null if the tile manager was instantiated with maximizedTileIndex.
Returns the splitter associated with this tile manager or
null if the tile manager was instantiated with maximizedTileIndex.
Code Sample

$('.selector').igTileManager("splitter")
widget

.igTileManager( "widget" );

Return Type:

object

Return Type Description:

Returns the element that represents this widget.
Returns the element that represents this widget.
Code Sample

$('.selector').igTileManager("widget");

ui-widget ui-igtilemanager ui-widget-content

Classes applied to the top container element.
ui-widget-content ui-igtile

Classes applied to the tile content element.
ui-widget-header ui-igtile-header

Classes applied to the tile header element.
ui-helper-hidden

Class applied to hide elements.
ui-state-hover

Class applied to the tile button elements when hovered.
ui-igtile-inner-container

Classes applied to the tile content inner container element.
ui-igtilemanager-left

Classes applied to the left panel.
ui-igtile-maximized

Classes applied to the tiles in maximized state.
ig-button ig-tile-minimize-button

Classes applied to the minimize button when a tile is in maximized state.
ui-igtile-minimized

Classes applied to the tiles in minimized state.
ig-tile-minimize-icon

Classes applied to the tile minimize button icon element in the header.
ui-helper-overflow-hidden

Class applied to hide scrollbars.
ui-helper-overflow-visible

Class applied to show overflowing elements.
ui-igtilemanager-right

Classes applied to the right panel.
ui-igsplitter-no-scroll

Class applied to right panel disabling the scroll while width is zero.
ui-helper-visibility-hidden

Class applied set element visibility to hidden.

Ignite UI for jQuery | API Reference

ui.igTileManager

Code Sample

Related Samples

Related Topics

Dependencies

Inherits