LayoutDefinition Class

TIBCO Spotfire 6.5 API Reference

Defines the layout structure and content to be applied within a Page.

Inheritance Hierarchy

System Object
Spotfire.Dxp.Application.Layout LayoutDefinition

Namespace: Spotfire.Dxp.Application.Layout
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 14.10.7525.5058 (14.10.7525.5058)

Syntax

C++

Copy to Clipboard Print

public sealed class LayoutDefinition

public sealed class LayoutDefinition

Remarks

Each BeginStackedSection/BeginSideBySideSection call splits the space available into two sections either vertically or horizontally. Space within a section is divided amongst the visuals that are actually added so if we make five subsections and only add a visual to one of them it will take the entire space of all the sections.

Examples

C++

Copy to Clipboard Print

public void TwoLevelsStartingHorizontally()
{
    // + - + - + - + 
    // | 1 | 2 | 3 | 
    // + - + - + - + 
    // |     4     | 
    // + - - - - - +

    Visual v1 = new VisualMock();
    Visual v2 = new VisualMock();
    Visual v3 = new VisualMock();
    Visual v4 = new VisualMock();

    LayoutDefinition ld = new LayoutDefinition();
    ld.BeginStackedSection();
        ld.BeginSideBySideSection();
            ld.Add(v1);
            ld.Add(v2);
            ld.Add(v3);
        ld.EndSection();
        ld.Add(v4);
    ld.EndSection();
}

public void TwoLevelsStartingHorizontally()
{
    // + - + - + - + 
    // | 1 | 2 | 3 | 
    // + - + - + - + 
    // |     4     | 
    // + - - - - - +

    Visual v1 = new VisualMock();
    Visual v2 = new VisualMock();
    Visual v3 = new VisualMock();
    Visual v4 = new VisualMock();

    LayoutDefinition ld = new LayoutDefinition();
    ld.BeginStackedSection();
        ld.BeginSideBySideSection();
            ld.Add(v1);
            ld.Add(v2);
            ld.Add(v3);
        ld.EndSection();
        ld.Add(v4);
    ld.EndSection();
}

Copy to Clipboard Print

public void ThreeLevelsStartingVertically()
{
    // + - - - + - + - + 
    // |       |   2   | 
    // |       + - + - + 
    // |   1   |   3   | 
    // |       + - + - + 
    // |       | 4 | 5 | 
    // + - - - + - + - +

    Visual v1 = new VisualMock();
    Visual v2 = new VisualMock();
    Visual v3 = new VisualMock();
    Visual v4 = new VisualMock();
    Visual v5 = new VisualMock();

    LayoutDefinition ld = new LayoutDefinition();
    ld.BeginSideBySideSection();
        ld.Add(v1);
        ld.BeginStackedSection();
            ld.Add(v2);
            ld.Add(v3);
            ld.BeginSideBySideSection();
                ld.Add(v4);
                ld.Add(v5);
            ld.EndSection();
        ld.EndSection();
    ld.EndSection();
}

public void ThreeLevelsStartingVertically()
{
    // + - - - + - + - + 
    // |       |   2   | 
    // |       + - + - + 
    // |   1   |   3   | 
    // |       + - + - + 
    // |       | 4 | 5 | 
    // + - - - + - + - +

    Visual v1 = new VisualMock();
    Visual v2 = new VisualMock();
    Visual v3 = new VisualMock();
    Visual v4 = new VisualMock();
    Visual v5 = new VisualMock();

    LayoutDefinition ld = new LayoutDefinition();
    ld.BeginSideBySideSection();
        ld.Add(v1);
        ld.BeginStackedSection();
            ld.Add(v2);
            ld.Add(v3);
            ld.BeginSideBySideSection();
                ld.Add(v4);
                ld.Add(v5);
            ld.EndSection();
        ld.EndSection();
    ld.EndSection();
}

Version Information

Supported in: 6.5, 6.0, 5.5, 5.0, 4.5