ASP.NET MVC Controls | ComponentOne
In This Topic
    DashboardLayout Class
    In This Topic
    File
    c1.nav.js
    Module
    c1.nav
    Base Class
    Control

    It is a consolidated display of many views and related information in a single place. It is used to compare and monitor a variety of data simultaneously. The different data views are displayed all at once. Now DashboardLayout supports three layouts: FlowLayout, GridLayout(Auto and Manual) and SplitLayout. The user can define many layouts by implementing the ILayout interface, or extending from the LayoutBase for simple.

    Constructor

    Properties

    Methods

    Events

    Constructor

    constructor

    constructor(element: any, options?: any): DashboardLayout
    

    Initializes a new instance of the DashboardLayout class.

    Parameters
    • element: any

      The DOM element that will host the control, or a selector for the host element (e.g. '#theCtrl').

    • options: any
    Optional

    JavaScript object containing initialization data for the control.

    Returns
    DashboardLayout

    Properties

    allowDrag

    Gets or sets a boolean value decides whether the tiles could be dragged.

    Type
    boolean

    allowHide

    Gets or sets a boolean value decides whether the tiles could be hidden.

    Type
    boolean

    allowMaximize

    Gets or sets a boolean value decides whether the tiles could be maximized.

    Type
    boolean

    allowResize

    Gets or sets a boolean value decides whether the tiles could be resized.

    Type
    boolean

    allowShowAll

    Gets or sets a boolean value decides whether the DashboardLayout could show all the tiles.

    Type
    boolean

    container

    Gets the element of the dashboard container.

    Type
    HTMLElement

     

    Static controlTemplate

    Gets or sets the template used to instantiate DashboardLayout control.

    Type
    any

    currentTile

    Gets the current tile in the dashboard.

    Type
    Tile

    hostElement

    Gets the DOM element that is hosting the control.

    Inherited From
    Control
    Type
    HTMLElement

    isDisabled

    Gets or sets a value that determines whether the control is disabled.

    Disabled controls cannot get mouse or keyboard events.

    Inherited From
    Control
    Type
    boolean

    isTouching

    Gets a value that indicates whether the control is currently handling a touch event.

    Inherited From
    Control
    Type
    boolean

    isUpdating

    Gets a value that indicates whether the control is currently being updated.

    Inherited From
    Control
    Type
    boolean

    layout

    Gets or sets the layout applied in this DashboardLayout control.

    Type
    ILayout

    rightToLeft

    Gets a value indicating whether the control is hosted in an element with right-to-left layout.

    Inherited From
    Control
    Type
    boolean

    tabOrder

    Gets or sets a value of the **tabindex** attribute associated with the control.

    **tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.

    Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.

    Inherited From
    Control
    Type
    number

    Methods

    addEventListener

    addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
    

    Adds an event listener to an element owned by this Control.

    The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).

    Failing to remove event listeners may cause memory leaks.

    The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.

    For details on passive event listeners, please see Improving scrolling performance with passive listeners.

    Parameters
    • target: EventTarget

      Target element for the event.

    • type: string

      String that specifies the event.

    • fn: any

      Function to execute when the event occurs.

    • capture: boolean
    Optional

    Whether the listener should be handled by the control before it is handled by the target element.

    Indicates that the handler will never call preventDefault().

    Inherited From
    Control
    Returns
    void

    applyTemplate

    applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
    

    Applies the template to a new instance of a control, and returns the root element.

    This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.

    For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

    ```typescript this.applyTemplate('wj-control wj-inputnumber', templateString, { _tbx: 'input', _btnUp: 'btn-inc', _btnDn: 'btn-dec' }, 'input'); ``````

    Parameters
    • classNames: string

      Names of classes to add to the control's host element.

    • template: string

      An HTML string that defines the control template.

    • parts: Object

      A dictionary of part variables and their names.

    • namePart: string Optional

      Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Inherited From
    Control
    Returns
    HTMLElement

    beginUpdate

    beginUpdate(): void
    

    Suspends notifications until the next call to endUpdate.

    Inherited From
    Control
    Returns
    void

    containsFocus

    containsFocus(): boolean
    

    Checks whether this control contains the focused element.

    Inherited From
    Control
    Returns
    boolean

    deferUpdate

    deferUpdate(fn: Function): void
    

    Executes a function within a beginUpdate/endUpdate block.

    The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

    Parameters
    Inherited From
    Control
    Returns
    void

    dispose

    dispose(): void
    

    Disposes of the control by removing its association with the host element.

    The dispose method automatically removes any event listeners added with the addEventListener method.

    Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

    Inherited From
    Control
    Returns
    void

    Static disposeAll

    disposeAll(e?: HTMLElement): void
    

    Disposes of all Wijmo controls contained in an HTML element.

    Parameters
    Inherited From
    Control
    Returns
    void

    endUpdate

    endUpdate(): void
    

    Resumes notifications suspended by calls to beginUpdate.

    Inherited From
    Control
    Returns
    void

    focus

    focus(): void
    

    Sets the focus to this control.

    Inherited From
    Control
    Returns
    void

    Static getControl

    getControl(element: any): Control
    

    Gets the control that is hosted in a given DOM element.

    Parameters
    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Inherited From
    Control
    Returns
    Control

    getTemplate

    getTemplate(): string
    

    Gets the HTML template used to create instances of the control.

    This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).

    Inherited From
    Control
    Returns
    string

    hide

    hide(tile: Tile): void
    

    Hides the tile.

    Parameters
    • tile: Tile

      The tile to be hidden.

    Returns
    void

    initialize

    initialize(options: any): void
    

    Initializes the control by copying the properties from a given object.

    This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

    For example:

    ```typescript grid.initialize({ itemsSource: myList, autoGenerateColumns: false, columns: [ { binding: 'id', header: 'Code', width: 130 }, { binding: 'name', header: 'Name', width: 60 } ] });

    // is equivalent to grid.itemsSource = myList; grid.autoGenerateColumns = false; // etc. ```

    The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

    Parameters
    • options: any

      Object that contains the initialization data.

    Inherited From
    Control
    Returns
    void

    invalidate

    invalidate(fullUpdate?: boolean): void
    

    Invalidates the control causing an asynchronous refresh.

    Parameters
    • fullUpdate: boolean Optional

      Whether to update the control layout as well as the content.

    Inherited From
    Control
    Returns
    void

    Static invalidateAll

    invalidateAll(e?: HTMLElement): void
    

    Invalidates all Wijmo controls contained in an HTML element.

    Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

    If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters
    • e: HTMLElement Optional

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Inherited From
    Control
    Returns
    void

    loadLayout

    loadLayout(value: string): void
    

    Loads the layout from a JSON string.

    Parameters
    • value: string

      A json string for a layout.

    Returns
    void

    onFormatTile

    onFormatTile(e: TileFormattedEventArgs): void
    

    Raises the formatTile event.

    Parameters
    Returns
    void

    onGotFocus

    onGotFocus(e?: EventArgs): void
    

    Raises the gotFocus event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onInvalidInput

    onInvalidInput(e: CancelEventArgs): void
    

    Raises the invalidInput event.

    If the event handler cancels the event, the control will keep the invalid input and the focus.

    Parameters
    Inherited From
    Control
    Returns
    void

    onLayoutChanged

    onLayoutChanged(): void
    

    Raises the layoutChanged event.

    Returns
    void

    onLostFocus

    onLostFocus(e?: EventArgs): void
    

    Raises the lostFocus event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onRefreshed

    onRefreshed(e?: EventArgs): void
    

    Raises the refreshed event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onRefreshing

    onRefreshing(e?: EventArgs): void
    

    Raises the refreshing event.

    Parameters
    Inherited From
    Control
    Returns
    void

    onTileActivated

    onTileActivated(e: TileEventArgs): void
    

    Raises the tileActivated event.

    Parameters
    Returns
    void

    onTileSizeChanged

    onTileSizeChanged(e: TileSizeChangedEventArgs): void
    

    Raises the tileSizeChanged event.

    Parameters
    Returns
    void

    refresh

    refresh(fullUpdate?: boolean): void
    

    Refreshes the control.

    Parameters
    • fullUpdate: boolean Optional

      Whether to update the control layout as well as the content.

    Returns
    void

    Static refreshAll

    refreshAll(e?: HTMLElement): void
    

    Refreshes all Wijmo controls contained in an HTML element.

    This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

    Parameters
    • e: HTMLElement Optional

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Inherited From
    Control
    Returns
    void

    remove

    remove(removedTile: Tile): void
    

    Removes the tile.

    Parameters
    • removedTile: Tile

      The tile to be removed.

    Returns
    void

    removeEventListener

    removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
    

    Removes one or more event listeners attached to elements owned by this Control.

    Parameters
    • target: EventTarget Optional

      Target element for the event. If null, removes listeners attached to all targets.

    • type: string Optional

      String that specifies the event. If null, removes listeners attached to all events.

    • fn: any Optional

      Handler to remove. If null, removes all handlers.

    • capture: boolean Optional

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Inherited From
    Control
    Returns
    number

    saveLayout

    saveLayout(): string
    

    Saves the current layout into a JSON string.

    The string represents an object with the layout type and the layout properties. With the loadLayout method, it can be used to persist the layouts defined by the users so they are preserved across sessions, and can also be used to implement undo/redo functionality in applications that allows users to modify the layout.

    The tile maximum state is temporary. It will not be saved.

    For example, the text represents a FlowLayout with two tiles and its direction is TopToDown.

    {
         "fullTypeName": "c1.nav.flow.FlowLayout",
         "layout": {
             "direction": 1,
             "items":[
                 {
                     "headerText": "This is the header text of the first tile.",
                     "content": "This is the content of the first tile."
                 },
                 {
                     "headerText": "This is the header text of the second tile.",
                     "content": "This is the content of the second tile."
                 }
             ]
         }
    }
    
    Returns
    string

    showAll

    showAll(): void
    

    Shows all the tiles.

    Returns
    void

    Events

    formatTile

    Occurs when an element representing a Tile has been created.

    For a tile, there are three areas: Header, Toolbar and Content. These areas can be customized via this event. The related dom elements or objects can be obtained in the event argument(TileFormattedEventArgs): headerElement, toolbar and contentElement.

    For example, this code sets the backgroundColor of the tile to 'red'.

    dashboard.formatTile.addHandler(function (s, e) {
    
      // add an image after the header title.
      var eleInfor = document.createElement('img');
      eleInfor.src = '~/Content/images/down.png';
      e.headerElement.appendChild(eleInfor);
    
      // append some text to the tile content.
      var spanText = document.createElement('span');
      spanText.innerText = 'This is the cost budgeting for the whole 2018 year!';
      e.contentElement.appendChild(spanText);
    
      // customize the toolbar.
      e.toolbar.clear(); //clear the toolbar items
      // add a item to export the chart.
      toolbar.insertToolbarItem({
         icon: '<img src="~/Content/images/export.png" />',
         title: 'Export',
         command: function () {
             var selector = e.tile.content,
                 chart = wijmo.Control.getControl(selector);
            chart.saveImageToFile(selector.substr(1) + '.png');
         }
     }, 0);
    
     // add a 'Delete' item in toolbar for removing the tile from the dashboard via dom.
     var iconClose = document.createElement('img');
     iconClose.style.marginLeft = '6px';
     iconClose.style.cursor = 'default';
     iconClose.src = '~/Content/images/close.png';
     e.toolbar.hostElement.appendChild(iconClose);
     iconClose.addEventListener('click', function () {
    
         // remove the tile from the dashboard.
         e.tile.remove();
     });
    });
    
    Arguments
    TileFormattedEventArgs

    gotFocus

    Occurs when the control gets the focus.

    Inherited From
    Control
    Arguments
    EventArgs

    invalidInput

    Occurs when invalid input is detected.

    Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.

    If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.

    If the event is not canceled, the control will ignore the invalid input and will retain the original content.

    Inherited From
    Control
    Arguments
    CancelEventArgs

    layoutChanged

    Occurs when the layout is changed.

    Arguments
    EventArgs

    lostFocus

    Occurs when the control loses the focus.

    Inherited From
    Control
    Arguments
    EventArgs

    refreshed

    Occurs after the control has refreshed its contents.

    Inherited From
    Control
    Arguments
    EventArgs

    refreshing

    Occurs when the control is about to refresh its contents.

    Inherited From
    Control
    Arguments
    EventArgs

    tileActivated

    Occurs when the tile is activated.

    Arguments
    TileEventArgs

    tileSizeChanged

    Occurs when the tile is maximized or restored.

    Arguments
    TileSizeChangedEventArgs