ASP.NET Core MVC Controls | ComponentOne
In This Topic
    SplitGroup Class
    In This Topic
    File
    c1.nav.js
    Module
    c1.nav.split
    Base Class
    Group

    Defines the group class for splitlayout.

    Constructor

    Properties

    Methods

    Constructor

    constructor

    constructor(opts?: any): SplitGroup
    

    Initializes a new SplitGroup.

    Parameters
    • opts: any
    Optional

    JavaScript object containing initialization data for the group.

    Returns
    SplitGroup

    Properties

    children

    Gets the child layoutitems.

    Inherited From
    Group
    Type
    LayoutItemCollection

    hostElement

    Gets the outest element which represents this layoutitem.

    Inherited From
    LayoutItem
    Type
    HTMLElement

    layout

    Gets the layout which owns this item.

    Inherited From
    LayoutItem
    Type
    LayoutBase

    orientation

    Gets or sets the orientation of the group.

    Type
    LayoutOrientation

    parent

    Gets the parent which owns this layoutitem.

    It could be a Group or a LayoutBase.

    Inherited From
    LayoutItem
    Type
    any

    size

    Gets or sets the size of the group.

    Tile size may be positive numbers (in pixels), null(fits the tile content) or strings in the format '{number}*' (star sizing).

    The star-sizing option performs a XAML-style dynamic sizing where column widths are proportional to the number before the star. For example, if a group has three tiles with sizes "100", "*", and "3*", the first column will be 100 pixels size, the second will take up 1/4th of the remaining space, and the last will take up the remaining 3/4ths of the remaining space.

    Star-sizing allows you to define tiles that automatically stretch to fill the space available. For example, set the size of the last tile to "*" and it will automatically extend to fill the entire group size so there's no empty space. You may also want to set the tile's minSize property to prevent the tile from getting too narrow.

    Type
    any

    Methods

    addEventListener

    addEventListener(target: EventTarget, type: string, fn: any, capture?: 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.

    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 is capturing.

    Inherited From
    DisposableObject
    Returns
    void

    dispose

    dispose(fullDispose?: boolean): void
    

    Disposes the object.

    Parameters
    Optional

    A boolean value decides wehter to keep the current status when disposing. If true, all the current status will be cleared. Otherwise, keep the current status.

    Returns
    void

    draw

    draw(): void
    

    Draws the group.

    Returns
    void

    initialize

    initialize(options: any): void
    

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

    Parameters
    • options: any

      Object that contains the initialization data.

    Inherited From
    LayoutItem
    Returns
    void

    remove

    remove(): boolean
    

    Removes the current layoutitem from its parent.

    Inherited From
    LayoutItem
    Returns
    boolean

    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
    DisposableObject
    Returns
    number

    render

    render(container?: HTMLElement): HTMLElement
    

    Renders the layoutitem in the specified container.

    Parameters
    • container: HTMLElement Optional

      the container element where the layoutitem renders in.

    Inherited From
    LayoutItem
    Returns
    HTMLElement