Class: Diagram#

A document for using offline drawio in an iframe

Hierarchy#

IFrame

↳ Diagram

Constructors#

constructor#

• new Diagram(options)

Parameters#

Name	Type
`options`	`IOptions`

Overrides#

IFrame.constructor

Defined in#

packages/ipydrawio/src/editor.ts:81

Properties#

adapter#

• adapter: IAdapter

Defined in#

packages/ipydrawio/src/editor.ts:67

revealed#

• revealed: Promise<void>

Defined in#

packages/ipydrawio/src/editor.ts:69

Accessors#

app#

• get app(): IMXApp

Returns#

IMXApp

Defined in#

packages/ipydrawio/src/editor.ts:98

• set app(app): void

Parameters#

Name	Type
`app`	`IMXApp`

Returns#

void

Defined in#

packages/ipydrawio/src/editor.ts:102

appChanged#

• get appChanged(): Signal<Diagram, void>

A signal emitted when the underlying drawio app changes

Returns#

Signal<Diagram, void>

Defined in#

packages/ipydrawio/src/editor.ts:128

escaped#

• get escaped(): ISignal<Diagram, void>

A signal emitted when the user indicates they want to return focus to the main app

Returns#

ISignal<Diagram, void>

Defined in#

packages/ipydrawio/src/editor.ts:135

format#

• get format(): null | IFormat<string>

Returns#

null | IFormat<string>

Defined in#

packages/ipydrawio/src/editor.ts:399

frameClicked#

• get frameClicked(): Signal<Diagram, void>

Returns#

Signal<Diagram, void>

Defined in#

packages/ipydrawio/src/editor.ts:403

loaded#

• get loaded(): ISignal<Diagram, void>

A signal emitted when a load action completes

Returns#

ISignal<Diagram, void>

Defined in#

packages/ipydrawio/src/editor.ts:142

ready#

• get ready(): Promise<void>

A promise that resolves when drawio is ready.

Returns#

Promise<void>

Defined in#

packages/ipydrawio/src/editor.ts:410

Methods#

exportAs#

▸ exportAs(format): Promise<string>

Get a an export string in one of the supported formats.

Parameters#

Name	Type
`format`	`string`

Returns#

Promise<string>

Defined in#

packages/ipydrawio/src/editor.ts:90

handleMessageEvent#

▸ handleMessageEvent(evt): void

Handle messages from the iframe over the drawio embed protocol

Parameters#

Name	Type
`evt`	`MessageEvent`<`any`>

Returns#

void

Defined in#

packages/ipydrawio/src/editor.ts:149

load#

▸ load(xml): void

Parameters#

Name	Type
`xml`	`string`

Returns#

void

Defined in#

packages/ipydrawio/src/editor.ts:392

maybeReloadFrame#

▸ maybeReloadFrame(force?): void

Determine the URL for the iframe src, reload if changed

Parameters#

Name	Type	Default value
`force`	`boolean`	`false`

Returns#

void

Defined in#

packages/ipydrawio/src/editor.ts:296

onAfterShow#

▸ onAfterShow(msg?): void

Install the message listener, the first time, and potentially reload the frame

Parameters#

Name	Type
`msg?`	`Message`

Returns#

void

Overrides#

IFrame.onAfterShow

Defined in#

packages/ipydrawio/src/editor.ts:219

onContentChanged#

▸ onContentChanged(): void

Handle a change to the raw document

Returns#

void

Defined in#

packages/ipydrawio/src/editor.ts:354

onSaveMsg#

▸ onSaveMsg(msg, hardSave?): void

Parameters#

Name	Type	Default value
`msg`	`any`	`undefined`
`hardSave`	`boolean`	`false`

Returns#

void

Defined in#

packages/ipydrawio/src/editor.ts:207

Copyright 2023 ipydrawio contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.