# Class: Diagram

[@deathbeds/ipydrawio](../modules/deathbeds_ipydrawio.md).Diagram

A document for using offline drawio in an iframe

## Hierarchy

- `IFrame`

  ↳ **`Diagram`**

## Constructors

### constructor

• **new Diagram**(`options`)

#### Parameters

| Name      | Type                                                                |
| :-------- | :------------------------------------------------------------------ |
| `options` | [`IOptions`](../interfaces/deathbeds_ipydrawio.Diagram.IOptions.md) |

#### Overrides

IFrame.constructor

#### Defined in

[packages/ipydrawio/src/editor.ts:81](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L81)

## Properties

### adapter

• **adapter**: [`IAdapter`](../interfaces/deathbeds_ipydrawio.IAdapter.md)

#### Defined in

[packages/ipydrawio/src/editor.ts:67](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L67)

---

### revealed

• **revealed**: `Promise`<`void`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:69](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L69)

## Accessors

### app

• `get` **app**(): [`IMXApp`](../interfaces/deathbeds_ipydrawio.IMXApp.md)

#### Returns

[`IMXApp`](../interfaces/deathbeds_ipydrawio.IMXApp.md)

#### Defined in

[packages/ipydrawio/src/editor.ts:98](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L98)

• `set` **app**(`app`): `void`

#### Parameters

| Name  | Type                                                    |
| :---- | :------------------------------------------------------ |
| `app` | [`IMXApp`](../interfaces/deathbeds_ipydrawio.IMXApp.md) |

#### Returns

`void`

#### Defined in

[packages/ipydrawio/src/editor.ts:102](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L102)

---

### appChanged

• `get` **appChanged**(): `Signal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md),
`void`\>

A signal emitted when the underlying drawio app changes

#### Returns

`Signal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md), `void`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:128](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L128)

---

### escaped

• `get` **escaped**(): `ISignal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md), `void`\>

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

#### Returns

`ISignal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md), `void`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:135](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L135)

---

### format

• `get` **format**(): `null` \|
[`IFormat`](../interfaces/deathbeds_ipydrawio.IFormat.md)<`string`\>

#### Returns

`null` \| [`IFormat`](../interfaces/deathbeds_ipydrawio.IFormat.md)<`string`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:399](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L399)

---

### frameClicked

• `get` **frameClicked**(): `Signal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md),
`void`\>

#### Returns

`Signal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md), `void`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:403](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L403)

---

### loaded

• `get` **loaded**(): `ISignal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md), `void`\>

A signal emitted when a load action completes

#### Returns

`ISignal`<[`Diagram`](deathbeds_ipydrawio.Diagram-1.md), `void`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:142](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L142)

---

### ready

• `get` **ready**(): `Promise`<`void`\>

A promise that resolves when drawio is ready.

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/ipydrawio/src/editor.ts:410](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L410)

## 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](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L90)

---

### 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](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L149)

---

### load

▸ **load**(`xml`): `void`

#### Parameters

| Name  | Type     |
| :---- | :------- |
| `xml` | `string` |

#### Returns

`void`

#### Defined in

[packages/ipydrawio/src/editor.ts:392](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L392)

---

### 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](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L296)

---

### 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](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L219)

---

### onContentChanged

▸ **onContentChanged**(): `void`

Handle a change to the raw document

#### Returns

`void`

#### Defined in

[packages/ipydrawio/src/editor.ts:354](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L354)

---

### 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](https://github.com/deathbeds/ipydrawio/blob/59b2750/packages/ipydrawio/src/editor.ts#L207)

```
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.
```