Editor | @kano/code

Hierarchy

EditorOrPlayer
- Editor

Index

Constructors

constructor

Events

Accessors

Methods

Constructors

constructor

new Editor(opts?: IEditorOptions): Editor

- Defined in app/lib/editor/editor.ts:177
Parameters
- Default value opts: IEditorOptions = {}
Returns Editor

Events

onDidInject

onDidInject:

onDidLayoutChange

onDidLayoutChange:

onDidLoad

onDidLoad:

onDidReset

onDidReset:

onRequestPlaySound

onRequestPlaySound:

Properties

activityBar

activityBar: ActivityBar = new ActivityBar()

config

config: any

Optional contentWidgets

contentWidgets: ContentWidgets

Optional creationPreviewProvider

creationPreviewProvider: CreationCustomPreviewProvider

dialogs

dialogs: Dialogs = new Dialogs()

domNode

domNode: KanoAppEditor = document.createElement('kano-app-editor') as KanoAppEditor

fileUpload

fileUpload: FileUpload

injected

injected: boolean = false

keybindings

keybindings: Keybindings = new Keybindings()

logger

logger: Logger = new Logger()

output

output: Output = new Output()

parts

parts: EditorPartsManager

Protected plugins

plugins: Plugin[] = []

Optional profile

profile: EditorProfile

queryEngine

queryEngine: QueryEngine = new QueryEngine()

sourceEditor

sourceEditor: SourceEditor

sourceType

sourceType: string = "blockly"

telemetry

telemetry: TelemetryClient = new TelemetryClient({ scope: 'kc-editor' })

toolbox

toolbox: Toolbox = new Toolbox()

Optional workspaceProvider

workspaceProvider: WorkspaceViewProvider

workspaceToolbar

workspaceToolbar: WorkspaceToolbar = new WorkspaceToolbar()

Accessors

root

root:

workspaceView

workspaceView:

Methods

addContentWidget

addContentWidget(widget: IEditorWidget): void

- Defined in app/lib/editor/editor.ts:547
Parameters
- widget: IEditorWidget
Returns void

addPlugin

addPlugin(plugin: Plugin): void

Overrides PluginReceiver.addPlugin
- Defined in app/lib/editor/editor.ts:266
Parameters
- plugin: Plugin
Returns void

Protected appendSourceEditor

appendSourceEditor(): void

- Defined in app/lib/editor/editor.ts:281
Returns void

appendWorkspaceView

appendWorkspaceView(): void

- Defined in app/lib/editor/editor.ts:526
Returns void

asAbsoluteMediaPath

asAbsoluteMediaPath(path?: string): string

- Defined in app/lib/editor/editor.ts:257
Parameters
- Default value path: string = ""
Returns string

createCreationDisplay

createCreationDisplay(blob: Blob): void

- Defined in app/lib/editor/editor.ts:468
Parameters
- blob: Blob
Returns void

createCreationPreview

createCreationPreview(externalOutput: Output): Blob | Promise<Blob>

- Defined in app/lib/editor/editor.ts:461
Parameters
- Optional externalOutput: Output
Returns Blob | Promise<Blob>

dispose

dispose(): void

- Defined in app/lib/editor/editor.ts:333
Returns void

Protected ensureProfile

ensureProfile(): void

- Defined in app/lib/editor/editor.ts:288
Returns void

export

export(): object

- Defined in app/lib/editor/editor.ts:412
Returns object

exportCreation

exportCreation(): object

- Defined in app/lib/editor/editor.ts:401
Returns object

exportToDisk

exportToDisk(fileName?: string): void

- Defined in app/lib/editor/editor.ts:426
Parameters
- Default value fileName: string = "my-app.kcode"
Returns void

exposeMethod

exposeMethod(name: string, method: Function): void

- Defined in app/lib/editor/editor.ts:621
Parameters
- name: string
- method: Function
Returns void

getBlocklyWorkspace

getBlocklyWorkspace(): any

- Defined in app/lib/editor/editor.ts:491
Returns any

getCode

getCode(): string

Overrides EditorOrPlayer.getCode
- Defined in app/lib/editor/editor.ts:481
Returns string

getSource

getSource(): string

- Defined in app/lib/editor/editor.ts:478
Returns string

getViewport

getViewport(): any

- Defined in app/lib/editor/editor.ts:484
Returns any

getWorkspace

getWorkspace(): any

- Defined in app/lib/editor/editor.ts:488
Returns any

importFromDisk

importFromDisk(): void

- Defined in app/lib/editor/editor.ts:442
Returns void

inject

inject(element?: HTMLElement, before: HTMLElement): void

Overrides EditorOrPlayer.inject
- Defined in app/lib/editor/editor.ts:298
Parameters
- Default value element: HTMLElement = document.body
- Optional before: HTMLElement
Returns void

layoutContentWidget

layoutContentWidget(widget: IEditorWidget): void

- Defined in app/lib/editor/editor.ts:557
Parameters
- widget: IEditorWidget
Returns void

load

load(app: any): void

- Defined in app/lib/editor/editor.ts:352
Parameters
- app: any
Returns void

playUISound

playUISound(name: string): void

- Defined in app/lib/editor/editor.ts:630
Parameters
- name: string
Returns void

queryElement

queryElement(selector: string): null | HTMLElement | SVGElement

- Defined in app/lib/editor/editor.ts:577
Parameters
- selector: string
Returns null | HTMLElement | SVGElement

queryPosition

queryPosition(selector: string): null | object

- Defined in app/lib/editor/editor.ts:588
Parameters
- selector: string
Returns null | object

querySelector

querySelector(selector: string): null | IQueryResult

- Defined in app/lib/editor/editor.ts:615
Parameters
- selector: string
Returns null | IQueryResult

registerAlias

registerAlias(alias: string, target: string): IDisposable

- Defined in app/lib/editor/editor.ts:624
Parameters
- alias: string
- target: string
Returns IDisposable

registerProfile

registerProfile(profile: EditorProfile): void

- Defined in app/lib/editor/editor.ts:494
Parameters
- profile: EditorProfile
Returns void

registerWorkspaceViewProvider

registerWorkspaceViewProvider(provider: WorkspaceViewProvider): void

- Defined in app/lib/editor/editor.ts:522
Parameters
- provider: WorkspaceViewProvider
Returns void

removeContentWidget

removeContentWidget(widget: IEditorWidget): void

- Defined in app/lib/editor/editor.ts:567
Parameters
- widget: IEditorWidget
Returns void

replaceSource

replaceSource(app: any): any

Inherited from EditorOrPlayer.replaceSource
- Defined in app/lib/editor/editor-or-player.ts:13
Parameters
- app: any
Returns any

reset

reset(trigger?: boolean): void

- Defined in app/lib/editor/editor.ts:374
Parameters
- Default value trigger: boolean = true
Returns void

resolvePosition

resolvePosition(result: IQueryResult): ClientRect | DOMRect

- Defined in app/lib/editor/editor.ts:539
Parameters
- result: IQueryResult
Returns ClientRect | DOMRect

restart

restart(): void

- Defined in app/lib/editor/editor.ts:395
Returns void

Protected runPluginChainTask

runPluginChainTask(taskName: PluginLifecycleStep, args: any[]): Promise<void>

Inherited from PluginReceiver.runPluginChainTask
- Defined in app/lib/editor/plugin/receiver.ts:16
Parameters
- taskName: PluginLifecycleStep
- Rest args: any[]
Returns Promise<void>

Protected runPluginTask

runPluginTask(taskName: PluginLifecycleStep, args: any[]): void

Inherited from PluginReceiver.runPluginTask
- Defined in app/lib/editor/plugin/receiver.ts:13
Parameters
- taskName: PluginLifecycleStep
- Rest args: any[]
Returns void

save

save(): object

- Defined in app/lib/editor/editor.ts:474
Returns object

setCode

setCode(content: undefined | string): void

- Defined in app/lib/editor/editor.ts:387
Parameters
- Optional content: undefined | string
Returns void

setInputDisabled

setInputDisabled(isInputDisabled: boolean): void

- Defined in app/lib/editor/editor.ts:273
Parameters
- isInputDisabled: boolean
Returns void

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Parameters

Default value opts: IEditorOptions = {}

Returns Editor

Events

onDidInject

onDidLayoutChange

onDidLoad

onDidReset

onRequestPlaySound

Properties

activityBar

config

Optional contentWidgets

Optional creationPreviewProvider

dialogs

domNode

fileUpload

injected

keybindings

logger

output

parts

Protected plugins

Optional profile

queryEngine

sourceEditor

sourceType

telemetry

toolbox

Optional workspaceProvider

workspaceToolbar

Accessors

root

workspaceView

Methods

addContentWidget

Parameters

widget: IEditorWidget

Returns void

addPlugin

Parameters

plugin: Plugin

Returns void

Protected appendSourceEditor

Returns void

appendWorkspaceView

Returns void

asAbsoluteMediaPath

Parameters

Default value path: string = ""

Returns string

createCreationDisplay

Parameters

blob: Blob

Returns void

createCreationPreview

Parameters

Optional externalOutput: Output

Returns Blob | Promise<Blob>

dispose

Returns void

Protected ensureProfile

Returns void

export

Returns object

exportCreation

Returns object

exportToDisk

Parameters

Default value fileName: string = "my-app.kcode"

Returns void