Winter Cardinal UI - v0.457.0 / DSelectOptions

Interface: DSelectOptions<VALUE, THEME, EMITTER>

DSelect options.

Type parameters

Name	Type
VALUE	unknown
THEME	extends DThemeSelect<VALUE> = DThemeSelect<VALUE>
EMITTER	any

Hierarchy

• DDropdownBaseOptions<VALUE, DMenuItem<VALUE> | null, THEME, EMITTER>

  ↳ DSelectOptions

  ↳↳ DDialogSelectCategoryOptions

  ↳↳ DTableBodyCellSelectMenuOptions

Table of contents

Properties

• background
• border
• children
• clear
• corner
• cursor
• group
• height
• image
• images
• interactive
• mask
• menu
• name
• on
• outline
• padding
• parent
• renderable
• shadow
• shortcut
• shortcuts
• state
• text
• theme
• title
• toggle
• value
• visible
• weight
• when
• width
• x
• y

Properties

background

• Optional background: DBaseBackgroundOptions

A background options.

Inherited from

DDropdownBaseOptions.background

Defined in

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

---

border

• Optional border: DBaseBorderOptions

A border options.

Inherited from

DDropdownBaseOptions.border

Defined in

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

---

children

• Optional children: (null | DisplayObject)[]

Children.

Inherited from

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

DDropdownBaseOptions.clear

Defined in

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

---

corner

• Optional corner: number | DBaseCornerOptions

A corner options.

Inherited from

DDropdownBaseOptions.corner

Defined in

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

---

cursor

• Optional cursor: DStateAwareOrValueMightBe<string>

A cursor shape.

Inherited from

DDropdownBaseOptions.cursor

Defined in

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

---

group

• Optional group: DButtonGroup<DButtonBase<any, any, any>, DButtonGroupOptions<DButtonBase<any, any, any>, any>>

A button group.

Inherited from

DDropdownBaseOptions.group

Defined in

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

---

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

DDropdownBaseOptions.height

Defined in

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

---

image

• Optional image: DImagePieceOptions

Inherited from

DDropdownBaseOptions.image

Defined in

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

---

images

• Optional images: DImagePieceOptions[]

Inherited from

DDropdownBaseOptions.images

Defined in

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

---

interactive

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

An interactivity option.

Inherited from

DDropdownBaseOptions.interactive

Defined in

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

---

mask

• Optional mask: boolean

Inherited from

DDropdownBaseOptions.mask

Defined in

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

---

menu

• Optional menu: DMenuOptions<VALUE, DThemeMenu> | DMenu<VALUE, DThemeMenu, DMenuOptions<VALUE, DThemeMenu>>

Menu options.

Inherited from

DDropdownBaseOptions.menu

Defined in

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

---

name

• Optional name: string

A name.

Inherited from

DDropdownBaseOptions.name

Defined in

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

---

on

• Optional on: DSelectOnOptions<VALUE, EMITTER>

Mappings of event names and handlers.

Overrides

DDropdownBaseOptions.on

Defined in

src/main/typescript/wcardinal/ui/d-select.ts:58

---

outline

• Optional outline: DBaseOutlineOptions

An outline options.

Inherited from

DDropdownBaseOptions.outline

Defined in

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

---

padding

• Optional padding: number | DBasePaddingOptions

A padding options.

Inherited from

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

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

DDropdownBaseOptions.renderable

Defined in

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

---

shadow

• Optional shadow: null | DBaseShadow

A shadow.

Inherited from

DDropdownBaseOptions.shadow

Defined in

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

---

shortcut

• Optional shortcut: string | UtilKeyboardEventShortcut

A shortcut option.

Inherited from

DDropdownBaseOptions.shortcut

Defined in

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

---

shortcuts

• Optional shortcuts: (string | UtilKeyboardEventShortcut)[]

A shortcut options.

Inherited from

DDropdownBaseOptions.shortcuts

Defined in

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

---

state

• Optional state: string | string[] | DBaseStateOptions

A default state.

Inherited from

DDropdownBaseOptions.state

Defined in

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

---

text

• Optional text: DTextPieceOptions<null | DMenuItem<VALUE, DThemeMenuItem, DMenuItemOptions<VALUE, DThemeMenuItem>>>

Inherited from

DDropdownBaseOptions.text

Defined in

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

---

theme

• Optional theme: string | THEME

A theme or a theme name.

Inherited from

DDropdownBaseOptions.theme

Defined in

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

---

title

• Optional title: string

A tooltip text.

Inherited from

DDropdownBaseOptions.title

Defined in

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

---

toggle

• Optional toggle: boolean

True to turn a toggle mode on.

Inherited from

DDropdownBaseOptions.toggle

Defined in

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

---

value

• Optional value: null | VALUE

A default value.

Defined in

src/main/typescript/wcardinal/ui/d-select.ts:56

---

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

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

DDropdownBaseOptions.weight

Defined in

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

---

when

• Optional when: "CLICKED" | "DOUBLE_CLICKED" | DButtonBaseWhen

An option when to activate a button.

Inherited from

DDropdownBaseOptions.when

Defined in

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

---

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

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

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

DDropdownBaseOptions.y

Defined in

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

Edit this page.