Interface: IFormat<T>#

@deathbeds/ipydrawio.IFormat

Type parameters#

Name

Type

T

string

Properties#

contentType#

Optional contentType: ContentType

Defined in#

packages/ipydrawio/src/tokens.ts:214


exporter#

Optional exporter: (drawio: Diagram, key: string, settings: ISettings) => Promise<null | T>

Type declaration#

▸ (drawio, key, settings): Promise<null | T>

Parameters#

Name

Type

drawio

Diagram

key

string

settings

ISettings

Returns#

Promise<null | T>

Defined in#

packages/ipydrawio/src/tokens.ts:219


ext#

ext: string

Defined in#

packages/ipydrawio/src/tokens.ts:208


factoryName#

factoryName: string

Defined in#

packages/ipydrawio/src/tokens.ts:225


format#

format: FileFormat

Defined in#

packages/ipydrawio/src/tokens.ts:211


fromXML#

Optional fromXML: (model: IModel, xml: string) => void

Type declaration#

▸ (model, xml): void

Parameters#

Name

Type

model

IModel

xml

string

Returns#

void

Defined in#

packages/ipydrawio/src/tokens.ts:218


icon#

icon: LabIcon

Defined in#

packages/ipydrawio/src/tokens.ts:210


isBinary#

Optional isBinary: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:230


isDefault#

Optional isDefault: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:234


isEditable#

Optional isEditable: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:233


isExport#

Optional isExport: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:229


isJson#

Optional isJson: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:232


isText#

Optional isText: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:231


isTransformed#

isTransformed: boolean

Defined in#

packages/ipydrawio/src/tokens.ts:235


key#

key: string

Defined in#

packages/ipydrawio/src/tokens.ts:206


label#

label: string

Defined in#

packages/ipydrawio/src/tokens.ts:209


load#

Optional load: (raw: string) => string

Type declaration#

▸ (raw): string

Parameters#

Name

Type

raw

string

Returns#

string

Defined in#

packages/ipydrawio/src/tokens.ts:216


mimetype#

mimetype: string

Defined in#

packages/ipydrawio/src/tokens.ts:212


modelName#

modelName: "base64" | "notebook" | "text"

Defined in#

packages/ipydrawio/src/tokens.ts:226


name#

name: string

Defined in#

packages/ipydrawio/src/tokens.ts:207


pattern#

Optional pattern: string

Defined in#

packages/ipydrawio/src/tokens.ts:213


save#

Optional save: (raw: string) => string

Type declaration#

▸ (raw): string

Parameters#

Name

Type

raw

string

Returns#

string

Defined in#

packages/ipydrawio/src/tokens.ts:215


toXML#

Optional toXML: (model: IModel) => string

Type declaration#

▸ (model): string

Parameters#

Name

Type

model

IModel

Returns#

string

Defined in#

packages/ipydrawio/src/tokens.ts:217

Methods#

wantsModel#

Optional wantsModel(contentsModel): boolean

Parameters#

Name

Type

contentsModel

Partial<IModel>

Returns#

boolean

Defined in#

packages/ipydrawio/src/tokens.ts:227

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.