Winter Cardinal UI - v0.442.0 / DBaseBackground

Class: DBaseBackground

Implements

• DBackgroundStateAware

Table of contents

Constructors

• constructor

Properties

• _alpha
• _callback
• _color
• _theme

Accessors

• alpha
• color

Methods

• getAlpha
• getColor
• getTheme
• onChange
• setTheme

Constructors

constructor

• new DBaseBackground(theme, options?, callback?): DBaseBackground

Parameters

Name	Type
theme	DThemeBase
options?	DBaseOptions<any, any>
callback?	() => void

Returns

DBaseBackground

Defined in

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

Properties

_alpha

• Protected Optional _alpha: DStateAwareOrValueMightBe<number>

Defined in

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

---

_callback

• Protected Optional _callback: () => void

Type declaration

▸ (): void

Returns

void

Defined in

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

---

_color

• Protected Optional _color: DStateAwareOrValueMightBe<null | number>

Defined in

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

---

_theme

• Protected _theme: DThemeBase

Defined in

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

Accessors

alpha

• get alpha(): DStateAwareOrValueMightBe<number>

Returns

DStateAwareOrValueMightBe<number>

Implementation of

DBackgroundStateAware.alpha

Defined in

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

• set alpha(alpha): void

Parameters

Name	Type
alpha	DStateAwareOrValueMightBe<number>

Returns

void

Implementation of

DBackgroundStateAware.alpha

Defined in

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

---

color

• get color(): DStateAwareOrValueMightBe<null | number>

Returns

DStateAwareOrValueMightBe<null | number>

Implementation of

DBackgroundStateAware.color

Defined in

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

• set color(color): void

Parameters

Name	Type
color	DStateAwareOrValueMightBe<null | number>

Returns

void

Implementation of

DBackgroundStateAware.color

Defined in

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

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DBackgroundStateAware.getAlpha

Defined in

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

---

getColor

▸ getColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Implementation of

DBackgroundStateAware.getColor

Defined in

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

---

getTheme

▸ getTheme(): DThemeBase

Returns

DThemeBase

Implementation of

DBackgroundStateAware.getTheme

Defined in

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

---

onChange

▸ onChange(): void

Returns

void

Defined in

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

---

setTheme

▸ setTheme(theme): void

Parameters

Name	Type
theme	DThemeBase

Returns

void

Implementation of

DBackgroundStateAware.setTheme

Defined in

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

Edit this page.