Module: @deathbeds/ipydrawio#

Type Aliases#

TMXGraphPanningEvent#

Ƭ TMXGraphPanningEvent: "panStart" | "panEnd" | "pan"

Defined in#

packages/ipydrawio/src/tokens.ts:385


TMXGraphSelectionEvent#

Ƭ TMXGraphSelectionEvent: "change"

Defined in#

packages/ipydrawio/src/tokens.ts:393


TMXGraphSelectionModelEvent#

Ƭ TMXGraphSelectionModelEvent: "change"

Defined in#

packages/ipydrawio/src/tokens.ts:397


TUIThemeOverrides#

Ƭ TUIThemeOverrides: Record<SCHEMA.UITheme, [string, string][]>

A type for describing how to transform a UI theme branding

Defined in#

packages/ipydrawio/src/tokens.ts:153


TUIThemes#

Ƭ TUIThemes: SCHEMA.UITheme

A hoisted set definition of theme elements

Defined in#

packages/ipydrawio/src/tokens.ts:138

Variables#

ALL_BINARY_FORMATS#

Const ALL_BINARY_FORMATS: IFormat<string>[]

Defined in#

packages/ipydrawio/src/io.ts:166


ALL_FORMATS#

Const ALL_FORMATS: IFormat<string>[]

Defined in#

packages/ipydrawio/src/io.ts:173


ALL_MIME_FORMATS#

Const ALL_MIME_FORMATS: IFormat<string>[]

these are last-in-wins, don’t claim existing ones

Defined in#

packages/ipydrawio/src/io.ts:171


ALL_TEXT_FORMATS#

Const ALL_TEXT_FORMATS: IFormat<string>[]

Defined in#

packages/ipydrawio/src/io.ts:168


BINARY_FACTORY#

Const BINARY_FACTORY: "Diagram Image"

The name of the factory that creates binary-based diagram widgets.

Defined in#

packages/ipydrawio/src/tokens.ts:53


CMD_NS#

Const CMD_NS: "ipydrawio"

A namespace for commands

Defined in#

packages/ipydrawio/src/tokens.ts:43


DEBUG#

Const DEBUG: boolean

Escape hatch for runtime debugging.

Defined in#

packages/ipydrawio/src/tokens.ts:82


DIAGRAM_MENU_RANK#

Const DIAGRAM_MENU_RANK: 99

A rank for adding to menus

Defined in#

packages/ipydrawio/src/tokens.ts:133


DRAWIO_ICON_CLASS_RE#

Const DRAWIO_ICON_CLASS_RE: RegExp

A regular expression for rewriting icons

Defined in#

packages/ipydrawio/src/tokens.ts:128


DRAWIO_ICON_SVG#

Const DRAWIO_ICON_SVG: string = ICON_SVG

The raw icon SVG

Defined in#

packages/ipydrawio/src/tokens.ts:63


IDiagramManager#

IDiagramManager: Token<IDiagramManager>

The token for the main extension, which can be used by other extensions

Defined in#

packages/ipydrawio/src/tokens.ts:101

packages/ipydrawio/src/tokens.ts:118

packages/ipydrawio/src/tokens.ts:169


IPYDRAWIO_METADATA#

Const IPYDRAWIO_METADATA: string = NS

The metadata key for diagrams in notebooks

Defined in#

packages/ipydrawio/src/tokens.ts:68


JSON_FACTORY#

Const JSON_FACTORY: "Diagram Notebook"

The name of the factory that creates JSON-based diagram widgets.

Defined in#

packages/ipydrawio/src/tokens.ts:58


MX_APP_MODEL_EVENTS#

Const MX_APP_MODEL_EVENTS: TMXAppModelEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:282


MX_EDITOR_EVENTS#

Const MX_EDITOR_EVENTS: TMXMEditorEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:311


MX_GRAPH_EVENTS#

Const MX_GRAPH_EVENTS: TMXGraphEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:341


MX_GRAPH_MODEL_EVENTS#

Const MX_GRAPH_MODEL_EVENTS: TMXGraphModelEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:364


MX_GRAPH_PAN_EVENTS#

Const MX_GRAPH_PAN_EVENTS: TMXGraphPanningEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:387


MX_GRAPH_SELECT_EVENTS#

Const MX_GRAPH_SELECT_EVENTS: TMXGraphSelectionEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:395


MX_GRAPH_SELECT_MODEL_EVENTS#

Const MX_GRAPH_SELECT_MODEL_EVENTS: TMXGraphSelectionModelEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:399


MX_GRAPH_VIEW_EVENTS#

Const MX_GRAPH_VIEW_EVENTS: TMXGraphViewEvent[]

Defined in#

packages/ipydrawio/src/tokens.ts:375


NS#

Const NS: string = PACKAGE.name

Defined in#

packages/ipydrawio/src/tokens.ts:31


PACKAGE#

Const PACKAGE: Object = _PACKAGE

Type declaration#

Name

Type

author

string

bugs

{ url: string = “https://github.com/deathbeds/ipydrawio/issues” }

bugs.url

string

dependencies

{ @deathbeds/ipydrawio-webpack: string = “^21.1.600”; @jupyterlab/application: string = “^3.1.0”; @jupyterlab/launcher: string = “^3.1.0”; @jupyterlab/mainmenu: string = “^3.1.0” }

dependencies.@deathbeds/ipydrawio-webpack

string

dependencies.@jupyterlab/application

string

dependencies.@jupyterlab/launcher

string

dependencies.@jupyterlab/mainmenu

string

description

string

devDependencies

{ @jupyter-widgets/base: string = “^4.0.0 || ^6.0.0”; @jupyter-widgets/controls: string = “^3.0.0 || ^5.0.0”; @jupyter-widgets/jupyterlab-manager: string = “^3.0.0 || ^5.0.0”; @jupyterlab/builder: string = “^3.6.1” }

devDependencies.@jupyter-widgets/base

string

devDependencies.@jupyter-widgets/controls

string

devDependencies.@jupyter-widgets/jupyterlab-manager

string

devDependencies.@jupyterlab/builder

string

files

string[]

homepage

string

jupyterlab

{ discovery: { server: { base: { name: string = “ipydrawio” } ; managers: string[] } } ; extension: string = “lib/plugin.js”; mimeExtension: string = “lib/mime.js”; outputDir: string = “../../py_packages/ipydrawio/_/ipydrawio”; schemaDir: string = “schema”; sharedPackages: { @deathbeds/ipydrawio-webpack: { bundled: boolean = false; singleton: boolean = true } ; @jupyter-widgets/base: { bundled: boolean = false; singleton: boolean = true } ; @jupyter-widgets/controls: { bundled: boolean = false; singleton: boolean = true } } }

jupyterlab.discovery

{ server: { base: { name: string = “ipydrawio” } ; managers: string[] } }

jupyterlab.discovery.server

{ base: { name: string = “ipydrawio” } ; managers: string[] }

jupyterlab.discovery.server.base

{ name: string = “ipydrawio” }

jupyterlab.discovery.server.base.name

string

jupyterlab.discovery.server.managers

string[]

jupyterlab.extension

string

jupyterlab.mimeExtension

string

jupyterlab.outputDir

string

jupyterlab.schemaDir

string

jupyterlab.sharedPackages

{ @deathbeds/ipydrawio-webpack: { bundled: boolean = false; singleton: boolean = true } ; @jupyter-widgets/base: { bundled: boolean = false; singleton: boolean = true } ; @jupyter-widgets/controls: { bundled: boolean = false; singleton: boolean = true } }

jupyterlab.sharedPackages.@deathbeds/ipydrawio-webpack

{ bundled: boolean = false; singleton: boolean = true }

jupyterlab.sharedPackages.@deathbeds/ipydrawio-webpack.bundled

boolean

jupyterlab.sharedPackages.@deathbeds/ipydrawio-webpack.singleton

boolean

jupyterlab.sharedPackages.@jupyter-widgets/base

{ bundled: boolean = false; singleton: boolean = true }

jupyterlab.sharedPackages.@jupyter-widgets/base.bundled

boolean

jupyterlab.sharedPackages.@jupyter-widgets/base.singleton

boolean

jupyterlab.sharedPackages.@jupyter-widgets/controls

{ bundled: boolean = false; singleton: boolean = true }

jupyterlab.sharedPackages.@jupyter-widgets/controls.bundled

boolean

jupyterlab.sharedPackages.@jupyter-widgets/controls.singleton

boolean

keywords

string[]

license

string

main

string

name

string

repository

{ type: string = “git”; url: string = “https://github.com/deathbeds/ipydrawio.git” }

repository.type

string

repository.url

string

scripts

{ build:pre: string = “python scripts/schema.py” }

scripts.build:pre

string

scripts_doit

{ build:pre: { file_dep: string[] ; targets: string[] } }

scripts_doit.build:pre

{ file_dep: string[] ; targets: string[] }

scripts_doit.build:pre.file_dep

string[]

scripts_doit.build:pre.targets

string[]

types

string

version

string

Defined in#

packages/ipydrawio/src/tokens.ts:29


PLUGIN_ID#

Const PLUGIN_ID: string

Defined in#

packages/ipydrawio/src/tokens.ts:33


PNG_EDITABLE#

Const PNG_EDITABLE: IFormat

Defined in#

packages/ipydrawio/src/io.ts:154


PNG_PLAIN#

Const PNG_PLAIN: IFormat

Defined in#

packages/ipydrawio/src/io.ts:138


SVG_EDITABLE#

Const SVG_EDITABLE: IFormat

Defined in#

packages/ipydrawio/src/io.ts:125


SVG_PLAIN#

Const SVG_PLAIN: IFormat

Defined in#

packages/ipydrawio/src/io.ts:108


TEXT_FACTORY#

Const TEXT_FACTORY: "Diagram"

The name of the factory that creates text-based diagram widgets.

Defined in#

packages/ipydrawio/src/tokens.ts:48


UI_THEMES#

Const UI_THEMES: UITheme[]

A concrete list of themes

Defined in#

packages/ipydrawio/src/tokens.ts:143


UI_THEME_BASE_COLOR#

Const UI_THEME_BASE_COLOR: "#f08705"

The theme color to replace

Defined in#

packages/ipydrawio/src/tokens.ts:148


UI_THEME_COLORS#

Const UI_THEME_COLORS: TUIThemeOverrides

Override colors for theme icons

Defined in#

packages/ipydrawio/src/tokens.ts:158


VERSION#

Const VERSION: string = PACKAGE.version

Defined in#

packages/ipydrawio/src/tokens.ts:32


XML_LEGACY#

Const XML_LEGACY: IFormat

Defined in#

packages/ipydrawio/src/io.ts:91


XML_NATIVE#

Const XML_NATIVE: IFormat

Defined in#

packages/ipydrawio/src/io.ts:70


drawioIcon#

Const drawioIcon: LabIcon

Defined in#

packages/ipydrawio/src/io.ts:55


drawioPlainIcon#

Const drawioPlainIcon: LabIcon

Defined in#

packages/ipydrawio/src/io.ts:34


drawioPngIcon#

Const drawioPngIcon: LabIcon

Defined in#

packages/ipydrawio/src/io.ts:65


drawioSvgIcon#

Const drawioSvgIcon: LabIcon

Defined in#

packages/ipydrawio/src/io.ts:60


drawioThemeIcons#

Const drawioThemeIcons: Record<UITheme, LabIcon>

Defined in#

packages/ipydrawio/src/io.ts:39

Functions#

stripDataURI#

stripDataURI(raw): string

Parameters#

Name

Type

raw

string

Returns#

string

Defined in#

packages/ipydrawio/src/utils.ts:18


unbase64SVG#

unbase64SVG(raw): string

Parameters#

Name

Type

raw

string

Returns#

string

Defined in#

packages/ipydrawio/src/utils.ts:22

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.