Winter Cardinal UI - v0.442.0 / DMenuBarOptions

Interface: DMenuBarOptions<VALUE, THEME>

DBase options.

Type parameters

Name	Type
VALUE	unknown
THEME	extends DThemeMenuBar = DThemeMenuBar

Hierarchy

• DLayoutHorizontalOptions<THEME>

  ↳ DMenuBarOptions

Table of contents

Properties

• background
• border
• children
• clear
• column
• corner
• cursor
• direction
• height
• interactive
• items
• margin
• name
• on
• outline
• padding
• parent
• renderable
• reverse
• row
• shadow
• shortcut
• shortcuts
• state
• theme
• title
• visible
• weight
• width
• x
• y

Properties

background

• Optional background: DBaseBackgroundOptions

A background options.

Inherited from

DLayoutHorizontalOptions.background

Defined in

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

---

border

• Optional border: DBaseBorderOptions

A border options.

Inherited from

DLayoutHorizontalOptions.border

Defined in

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

---

children

• Optional children: (null | DisplayObject)[]

Children.

Inherited from

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

DLayoutHorizontalOptions.clear

Defined in

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

---

column

• Optional column: number

Inherited from

DLayoutHorizontalOptions.column

Defined in

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

---

corner

• Optional corner: number | DLayoutCornerOptions

A corner options.

Inherited from

DLayoutHorizontalOptions.corner

Defined in

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

---

cursor

• Optional cursor: DStateAwareOrValueMightBe<string>

A cursor shape.

Inherited from

DLayoutHorizontalOptions.cursor

Defined in

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

---

direction

• Optional direction: "VERTICAL" | "HORIZONTAL" | DLayoutDirection

Inherited from

DLayoutHorizontalOptions.direction

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:35

---

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

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

DLayoutHorizontalOptions.interactive

Defined in

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

---

items

• Optional items: (null | DisplayObject | DMenuBarItemOptions<VALUE, DThemeMenuBarItem<VALUE>> | DMenuBarItemSpaceOptions<DThemeMenuBarItemSpace>)[]

Defined in

src/main/typescript/wcardinal/ui/d-menu-bar.ts:26

---

margin

• Optional margin: number | DLayoutMarginOptions

Inherited from

DLayoutHorizontalOptions.margin

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:31

---

name

• Optional name: string

A name.

Inherited from

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

DLayoutHorizontalOptions.on

Defined in

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

---

outline

• Optional outline: DBaseOutlineOptions

An outline options.

Inherited from

DLayoutHorizontalOptions.outline

Defined in

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

---

padding

• Optional padding: number | DBasePaddingOptions

A padding options.

Inherited from

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

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

DLayoutHorizontalOptions.renderable

Defined in

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

---

reverse

• Optional reverse: boolean

Inherited from

DLayoutHorizontalOptions.reverse

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:36

---

row

• Optional row: number

Inherited from

DLayoutHorizontalOptions.row

Defined in

src/main/typescript/wcardinal/ui/d-layout.ts:33

---

shadow

• Optional shadow: null | DBaseShadow

A shadow.

Inherited from

DLayoutHorizontalOptions.shadow

Defined in

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

---

shortcut

• Optional shortcut: string | UtilKeyboardEventShortcut

A shortcut option.

Inherited from

DLayoutHorizontalOptions.shortcut

Defined in

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

---

shortcuts

• Optional shortcuts: (string | UtilKeyboardEventShortcut)[]

A shortcut options.

Inherited from

DLayoutHorizontalOptions.shortcuts

Defined in

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

---

state

• Optional state: string | string[] | DBaseStateOptions

A default state.

Inherited from

DLayoutHorizontalOptions.state

Defined in

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

---

theme

• Optional theme: string | THEME

A theme or a theme name.

Inherited from

DLayoutHorizontalOptions.theme

Defined in

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

---

title

• Optional title: string

A tooltip text.

Inherited from

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

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

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

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

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

DLayoutHorizontalOptions.y

Defined in

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

Edit this page.