Winter Cardinal UI - v0.442.0 / DScrollBarOptions

Interface: DScrollBarOptions<THEME>

DBase options.

Type parameters

Name	Type
`THEME`	extends `DThemeScrollBar` = `DThemeScrollBar`

Hierarchy

DBaseOptions<THEME>

↳ DScrollBarOptions

Table of contents

Properties

Properties

background

• Optional background: DBaseBackgroundOptions

A background options.

Inherited from

DBaseOptions.background

Defined in

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

border

• Optional border: DBaseBorderOptions

A border options.

Inherited from

DBaseOptions.border

Defined in

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

children

• Optional children: (null | DisplayObject)[]

Children.

Inherited from

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

DBaseOptions.clear

Defined in

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

corner

• Optional corner: number | DBaseCornerOptions

A corner options.

Inherited from

DBaseOptions.corner

Defined in

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

cursor

• Optional cursor: DStateAwareOrValueMightBe<string>

A cursor shape.

Inherited from

DBaseOptions.cursor

Defined in

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

fadeOut

• Optional fadeOut: DScrollBarFadeOutOpiotns

Defined in

src/main/typescript/wcardinal/ui/d-scroll-bar.ts:19

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

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

DBaseOptions.interactive

Defined in

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

name

• Optional name: string

A name.

Inherited from

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

DBaseOptions.on

Defined in

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

outline

• Optional outline: DBaseOutlineOptions

An outline options.

Inherited from

DBaseOptions.outline

Defined in

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

padding

• Optional padding: number | DBasePaddingOptions

A padding options.

Inherited from

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

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

DBaseOptions.renderable

Defined in

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

shadow

• Optional shadow: null | DBaseShadow

A shadow.

Inherited from

DBaseOptions.shadow

Defined in

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

shortcut

• Optional shortcut: string | UtilKeyboardEventShortcut

A shortcut option.

Inherited from

DBaseOptions.shortcut

Defined in

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

shortcuts

• Optional shortcuts: (string | UtilKeyboardEventShortcut)[]

A shortcut options.

Inherited from

DBaseOptions.shortcuts

Defined in

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

state

• Optional state: string | string[] | DBaseStateOptions

A default state.

Inherited from

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

DBaseOptions.theme

Defined in

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

thumb

• Optional thumb: DScrollBarThumbOptions

Defined in

src/main/typescript/wcardinal/ui/d-scroll-bar.ts:18

title

• Optional title: string

A tooltip text.

Inherited from

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

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

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

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

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

Defined in

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

Edit this page.