Winter Cardinal UI - v0.442.0 / DDiagramCanvasEditorOptions

Interface: DDiagramCanvasEditorOptions<THEME>

DBase options.

Type parameters

Name	Type
THEME	extends DThemeDiagramCanvasEditor = DThemeDiagramCanvasEditor

Hierarchy

• DDiagramCanvasBaseOptions<THEME>

  ↳ DDiagramCanvasEditorOptions

Table of contents

Properties

• ambient
• background
• border
• category
• children
• clear
• corner
• cursor
• description
• height
• interactive
• label
• name
• on
• outline
• padding
• parent
• renderable
• shadow
• shortcut
• shortcuts
• snap
• state
• summary
• theme
• tile
• title
• visible
• weight
• width
• x
• y

Properties

ambient

• Optional ambient: boolean

Inherited from

DDiagramCanvasBaseOptions.ambient

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:28

---

background

• Optional background: DDiagramCanvasBackgroundOptions

A background options.

Inherited from

DDiagramCanvasBaseOptions.background

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:27

---

border

• Optional border: DBaseBorderOptions

A border options.

Inherited from

DDiagramCanvasBaseOptions.border

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:499

---

category

• Optional category: null | string

Inherited from

DDiagramCanvasBaseOptions.category

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:23

---

children

• Optional children: (null | DisplayObject)[]

Children.

Inherited from

DDiagramCanvasBaseOptions.children

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:399

---

clear

• Optional clear: number | "NONE" | "BOTH" | "BEFORE" | "AFTER"

A clear type used by DLayoutVertical and DLayoutHorizontal.

Inherited from

DDiagramCanvasBaseOptions.clear

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:508

---

corner

• Optional corner: number | DBaseCornerOptions

A corner options.

Inherited from

DDiagramCanvasBaseOptions.corner

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:471

---

cursor

• Optional cursor: DStateAwareOrValueMightBe<string>

A cursor shape.

Inherited from

DDiagramCanvasBaseOptions.cursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:511

---

description

• Optional description: string

Inherited from

DDiagramCanvasBaseOptions.description

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:25

---

height

• Optional height: DCoordinateSize

One of the followings:

• A height
• A size keyword
• A size expression (Parsed by DScalarExpression)
• A function returning a hight (DScalarFunction)
• An object returning a hight (DScalar)

Inherited from

DDiagramCanvasBaseOptions.height

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:442

---

interactive

• Optional interactive: number | "NONE" | "SELF" | "CHILDREN" | "BOTH"

An interactivity option.

Inherited from

DDiagramCanvasBaseOptions.interactive

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:465

---

label

• Optional label: string

Inherited from

DDiagramCanvasBaseOptions.label

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:22

---

name

• Optional name: string

A name.

Inherited from

DDiagramCanvasBaseOptions.name

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:402

---

on

• Optional on: DBaseOnOptions<any>

Mappings of event names and event handlers.

Inherited from

DDiagramCanvasBaseOptions.on

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:479

---

outline

• Optional outline: DBaseOutlineOptions

An outline options.

Inherited from

DDiagramCanvasBaseOptions.outline

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:502

---

padding

• Optional padding: number | DBasePaddingOptions

A padding options.

Inherited from

DDiagramCanvasBaseOptions.padding

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:468

---

parent

• Optional parent: Container

A parent.

In the case of UI classes which pop up (e.g., DDialog and DMenu), if multiple application instances are there, better to set this to an application.stage so that they pick a right application. By default, they assume the last created application is the one they belong to at the time when they are created.

Inherited from

DDiagramCanvasBaseOptions.parent

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:396

---

renderable

• Optional renderable: boolean

A renderability. Unlike visible, non-renderable element occupies a space. Set to true to make DBase renderable. Set to false to make DBase not renderable. The default value is true.

Inherited from

DDiagramCanvasBaseOptions.renderable

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:459

---

shadow

• Optional shadow: null | DBaseShadow

A shadow.

Inherited from

DDiagramCanvasBaseOptions.shadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:505

---

shortcut

• Optional shortcut: string | UtilKeyboardEventShortcut

A shortcut option.

Inherited from

DDiagramCanvasBaseOptions.shortcut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:490

---

shortcuts

• Optional shortcuts: (string | UtilKeyboardEventShortcut)[]

A shortcut options.

Inherited from

DDiagramCanvasBaseOptions.shortcuts

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:493

---

snap

• Optional snap: DDiagramCanvasEditorSnapOptions

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-editor.ts:29

---

state

• Optional state: string | string[] | DBaseStateOptions

A default state.

Inherited from

DDiagramCanvasBaseOptions.state

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:462

---

summary

• Optional summary: string

Inherited from

DDiagramCanvasBaseOptions.summary

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:24

---

theme

• Optional theme: string | THEME

A theme or a theme name.

Inherited from

DDiagramCanvasBaseOptions.theme

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:474

---

tile

• Optional tile: DDiagramCanvasTileOptions

Inherited from

DDiagramCanvasBaseOptions.tile

Defined in

src/main/typescript/wcardinal/ui/d-diagram-canvas-base.ts:26

---

title

• Optional title: string

A tooltip text.

Inherited from

DDiagramCanvasBaseOptions.title

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:487

---

visible

• Optional visible: boolean

A visibility. Set to true to make DBase visible. Set to false to make DBase invisible. The default value is true.

Inherited from

DDiagramCanvasBaseOptions.visible

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:450

---

weight

• Optional weight: number

A weight used by DLayoutVertical and DLayoutHorizontal.

Inherited from

DDiagramCanvasBaseOptions.weight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:484

---

width

• Optional width: DCoordinateSize

One of the followings:

• A width
• A size keyword
• A size expression (Parsed by DScalarExpression)
• A function returning a width (DScalarFunction)
• An object returning a width (DScalar)

Inherited from

DDiagramCanvasBaseOptions.width

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:432

---

x

• Optional x: DCoordinatePosition

One of the followings:

• A X position
• A position keyword
• A position expression (Parsed by DScalarExpression)
• A function returning a X position (DScalarFunction)
• An object returning a X position (DScalar)

Inherited from

DDiagramCanvasBaseOptions.x

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:412

---

y

• Optional y: DCoordinatePosition

One of the followings:

• A Y position
• A position keyword
• A position expresion (Parsed by DScalarExpression)
• A function returning a Y position (DScalarFunction)
• An object returning a Y position (DScalar)

Inherited from

DDiagramCanvasBaseOptions.y

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:422

Edit this page.