AboutSupportDeveloper GuideVersion 47.156.100.62
OpenFin JavaScript API
    Preparing search index...

    Interface LayoutComponent

    interface LayoutComponent {
        componentName: "view";
        componentState?: Partial<ViewCreationOptions>;
        height?: number;
        id?: string | string[];
        isClosable?: boolean;
        pinned?: boolean;
        title?: string;
        type: "component";
        width?: number;
    }
    Index
    componentName: "view"

    Only a component type will have this property and it should be set to view.

    componentState?: Partial<ViewCreationOptions>

    Only a component type will have this property and it represents the view options of a given component.

    height?: number
    id?: string | string[]
    isClosable?: boolean
    pinned?: boolean

    Platforms only. Pins the tab to the leading pinned area of its stack (sibling to componentState; not a view option). Users cannot drag pinned tabs out of their stack or into another window; API moves within a layout keep the pin. Unless allowUserPinning is true, they also cannot be closed or reordered. Use setViewPinned to change it at runtime.

    NOTE: Only applies with layout engine 'v2' and settings.tabOverflowBehavior: 'scroll'.

    title?: string
    type: "component"
    width?: number