Interface Options

interface Options {
    controllerId?: string;
    initialProjects: () => Promise<PythonProject[]>;
    onWorkspaceLoaded(event: PythonEditorWorkspaceRequest): void;
    onWorkspaceSave(event: PythonEditorWorkspaceRequest): void;
    onWorkspaceSync(event: PythonEditorWorkspaceRequest): void;
}

Index

Properties

controllerId? initialProjects

Methods

onWorkspaceLoaded? onWorkspaceSave? onWorkspaceSync?

Properties

`Optional`controllerId

controllerId?: string

Set this to a value representing your app.

initialProjects

initialProjects: () => Promise<PythonProject[]>

A function that provides the initial set of projects to be used.

This will also be used if the iframe reloads itself.

Methods

`Optional`onWorkspaceLoaded

onWorkspaceLoaded(event: PythonEditorWorkspaceRequest): void
Called when the workspace sync is complete.
Parameters
- event: PythonEditorWorkspaceRequest
Returns void
- Defined in src/vanilla/python-editor-frame-driver.ts:61

`Optional`onWorkspaceSave

onWorkspaceSave(event: PythonEditorWorkspaceRequest): void
Implement this to update the data store that initialProjects reads from.
Parameters
- event: PythonEditorWorkspaceRequest
Returns void
- Defined in src/vanilla/python-editor-frame-driver.ts:66

`Optional`onWorkspaceSync

onWorkspaceSync(event: PythonEditorWorkspaceRequest): void
Called when the workspace is ready to sync.
Parameters
- event: PythonEditorWorkspaceRequest
Returns void
- Defined in src/vanilla/python-editor-frame-driver.ts:56