Winter Cardinal UI - v0.457.0 / DTreeOptions

Interface: DTreeOptions<NODE, DATA, THEME, CONTENT_OPTIONS>

DPane options.

Type parameters

Name	Type
`NODE`	extends `DTreeNode` = `DTreeNode`
`DATA`	extends `DTreeData`<`NODE`> = `DTreeData`<`NODE`>
`THEME`	extends `DThemeTree` = `DThemeTree`
`CONTENT_OPTIONS`	extends `DBaseOptions` = `DContentOptions`

Hierarchy

DPaneOptions<THEME, CONTENT_OPTIONS>

↳ DTreeOptions

Properties

background

• Optional background: DBaseBackgroundOptions

A background options.

Inherited from

DPaneOptions.background

Defined in

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

border

• Optional border: DBaseBorderOptions

A border options.

Inherited from

DPaneOptions.border

Defined in

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

children

• Optional children: (null | DisplayObject)[]

Children.

Inherited from

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

DPaneOptions.clear

Defined in

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

content

• Optional content: DBase<DThemeBase, DBaseOptions<DThemeBase, any>> | CONTENT_OPTIONS

Content options or a content.

Inherited from

DPaneOptions.content

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:39

corner

• Optional corner: number | DBaseCornerOptions

A corner options.

Inherited from

DPaneOptions.corner

Defined in

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

cursor

• Optional cursor: DStateAwareOrValueMightBe<string>

A cursor shape.

Inherited from

DPaneOptions.cursor

Defined in

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

data

• Optional data: DATA | NODE[] | DTreeDataOptions<NODE>

A data options.

Defined in

src/main/typescript/wcardinal/ui/d-tree.ts:37

gesture

• Optional gesture: DPaneGestureOptions

Gesture options.

Inherited from

DPaneOptions.gesture

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:49

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

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

DPaneOptions.interactive

Defined in

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

mask

• Optional mask: boolean

True to enable an overflow mask.

Inherited from

DPaneOptions.mask

Defined in

src/main/typescript/wcardinal/ui/d-pane.ts:34

name

• Optional name: string

A name.

Inherited from

DPaneOptions.name

Defined in

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

nodes

• Optional nodes: NODE[]

An alias for data.

Defined in

src/main/typescript/wcardinal/ui/d-tree.ts:32

on

• Optional on: DBaseOnOptions<any>

Mappings of event names and event handlers.

Inherited from

DPaneOptions.on

Defined in

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

outline

• Optional outline: DBaseOutlineOptions

An outline options.

Inherited from

DPaneOptions.outline

Defined in

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

padding

• Optional padding: number | DBasePaddingOptions

A padding options.

Inherited from

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

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