Angular DockingLayout Component

The DockingLayout component for Angular which allows the creation of complex layouts with panels that can be floated, docked, nested, resized, pinned, unpinned and closed.

Prerequisites

Refer to Angular Getting Started before you start with this help topic.

Configuration

The DockingLayout component for Angular requires the following imports.

Mark a class as an Angular component through the @Component decorator:

The full list of @Component decorator properties is available on: Angular @Component Decorator API

Every jQWidgets Angular component has an [auto-create] attribute which determines whether the component is automatically created or is created on demand by API method call.
By default, the [auto-create] attribute value is true.


Create the AppComponent class.

The AppComponent class is used to instantiate the app. In some of the examples, we use @ViewChild and ngAfterViewInit.

The following example demonstrates the DockingLayout component for Angular.

app.component.htm

app.component.css

app.component.ts

Run Code

Create DockingLayout component with JSON

Properties

The properties which are defined as attributes can be changed directly:

To get or set a property, which we did not define or call a method, we can do the following:

Every component has a method setOptions which accepts a JSON object as an argument. This object contains component settings and you can use it to set a single or multiple properties dynamically.

Events

The pin event is triggered when a group has been pinned.

The following example demonstrates how to add an event listener.

Note: Event Names of the DockingLayout component for Angular are the same as the Event Names of the jqxDockingLayout widget.
The only thing you need to do is to put "on" before the event name and upperCase it's the first letter.

Methods

To invoke methods, you can use the DockingLayout reference.
 ( refresh() to refreshes the widget )  - this.myDockingLayout.refresh().

The following example demonstrates how to invoke methods of the DockingLayout component for Angular.

DockingLayout Examples

Overview

The following example demonstrates how to create a DockingLayout component for Angular.

Resizable

The following example demonstrates how to create panels to disable dynamically resized in DockingLayout.

DockingLayout API

API Reference of the jQWidgets DockingLayout component for Angular: DockingLayout API