Class _WindowModule

Deprecated

me should only be accessed from the fin global (FinApi.me); access through entity classes is not guaranteed to behave sensibly in all calling contexts.

Creates a new Window.

Example

async function createWindow() {
    const winOption = {
        name:'child',
        defaultWidth: 300,
        defaultHeight: 300,
        url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
        frame: true,
        autoShow: true
    };
    return await fin.Window.create(winOption);
}

createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
Copy

Asynchronously returns a Window object that represents the current window

Example

fin.Window.getCurrent()
.then(wnd => console.log('current window'))
.catch(err => console.log(err));

Copy

Synchronously returns a Window object that represents the current window

Example

const wnd = fin.Window.getCurrentSync();
const info = await wnd.getInfo();
console.log(info);

Copy

Asynchronously returns an API handle for the given Window identity.

Remarks

Wrapping a Window identity that does not yet exist will not throw an error, and instead returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing for a Window throughout its entire lifecycle.

Example

async function createWin() {
    const app = await fin.Application.start({
        name: 'myApp',
        uuid: 'app-1',
        url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
        autoShow: true
    });
    return await app.getWindow();
}
createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
.then(win => console.log('wrapped window'))
.catch(err => console.log(err));
Copy

Synchronously returns an API handle for the given Window identity.

Remarks

Wrapping a Window identity that does not yet exist will not throw an error, and instead returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing for a Window throughout its entire lifecycle.

Example

async function createWin() {
    const app = await fin.Application.start({
        name: 'myApp',
        uuid: 'app-1',
        url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
        autoShow: true
    });
    return await app.getWindow();
}
await createWin();
let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
Copy