Winter Cardinal UI - v0.442.0 / DDiagramBaseOptions

Interface: DDiagramBaseOptions<CANVAS, CANVAS_OPTIONS, CONTROLLER, THEME, EMITTER>

Type parameters

Name	Type
`CANVAS`	extends `DDiagramCanvasBase` = `DDiagramCanvasBase`
`CANVAS_OPTIONS`	extends `DDiagramCanvasBaseOptions` = `DDiagramCanvasBaseOptions`
`CONTROLLER`	extends `DDiagramBaseController` = `DDiagramBaseController`
`THEME`	extends `DThemeDiagramBase` = `DThemeDiagramBase`
`EMITTER`	`any`

Hierarchy

DCanvasContainerOptions<CANVAS, CANVAS_OPTIONS, THEME>

↳ DDiagramBaseOptions

↳↳ DDiagramEditorOptions

↳↳ DDiagramOptions

Properties

ambient

• Optional ambient: boolean

Defined in

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

background

• Optional background: DBaseBackgroundOptions

A background options.

Inherited from

DCanvasContainerOptions.background

Defined in

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

border

• Optional border: DBaseBorderOptions

A border options.

Inherited from

DCanvasContainerOptions.border

Defined in

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

canvas

• Optional canvas: CANVAS

Inherited from

DCanvasContainerOptions.canvas

Defined in

src/main/typescript/wcardinal/ui/d-canvas-container.ts:55

children

• Optional children: (null | DisplayObject)[]

Children.

Inherited from

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

DCanvasContainerOptions.clear

Defined in

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

controller

• Optional controller: CONTROLLER

Defined in

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

corner

• Optional corner: number | DBaseCornerOptions

A corner options.

Inherited from

DCanvasContainerOptions.corner

Defined in

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

cursor

• Optional cursor: DStateAwareOrValueMightBe<string>

A cursor shape.

Inherited from

DCanvasContainerOptions.cursor

Defined in

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

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

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

DCanvasContainerOptions.interactive

Defined in

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

mask

• Optional mask: boolean

Inherited from

DCanvasContainerOptions.mask

Defined in

src/main/typescript/wcardinal/ui/d-canvas-container.ts:53

name

• Optional name: string

A name.

Inherited from

DCanvasContainerOptions.name

Defined in

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

on

• Optional on: DDiagramBaseOnOptions<CANVAS, EMITTER>

Mappings of event names and event handlers.

Overrides

DCanvasContainerOptions.on

Defined in

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

outline

• Optional outline: DBaseOutlineOptions

An outline options.

Inherited from

DCanvasContainerOptions.outline

Defined in

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

padding

• Optional padding: number | DBasePaddingOptions

A padding options.

Inherited from

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

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