Winter Cardinal UI - v0.457.0 / DThemeDarkButtonColorGradient

Class: DThemeDarkButtonColorGradient

DButtonColorGradient theme.

Hierarchy

• DThemeDarkButton<DColorGradientObservable>

  ↳ DThemeDarkButtonColorGradient

Implements

• DThemeButtonColorGradient

Table of contents

Constructors

• constructor

Properties

• BACKGROUND_COLOR
• BACKGROUND_COLOR_HOVERED
• BACKGROUND_COLOR_PRESSED
• OUTLINE_COLOR

Methods

• getAlpha
• getBackgroundAlpha
• getBackgroundColor
• getBackgroundTexture
• getBorderAlign
• getBorderAlpha
• getBorderColor
• getBorderMask
• getBorderTexture
• getBorderWidth
• getCheckerColors
• getClearType
• getColor
• getCornerMask
• getCornerRadius
• getCursor
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getHeight
• getImageAlignHorizontal
• getImageAlignVertical
• getImageAlignWith
• getImageMarginHorizontal
• getImageMarginVertial
• getImageRotation
• getImageSource
• getImageTintAlpha
• getImageTintColor
• getInteractive
• getLineHeight
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineColorActive
• getOutlineColorNonActive
• getOutlineMask
• getOutlineOffset
• getOutlineOffsetActive
• getOutlineOffsetNonActive
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getSecondaryImageAlignHorizontal
• getSecondaryImageAlignVertical
• getSecondaryImageAlignWith
• getSecondaryImageMarginHorizontal
• getSecondaryImageMarginVertial
• getSecondaryImageRotation
• getSecondaryImageTintAlpha
• getSecondaryImageTintColor
• getShadow
• getTertiaryImageAlignHorizontal
• getTertiaryImageAlignVertical
• getTertiaryImageAlignWith
• getTertiaryImageMarginHorizontal
• getTertiaryImageMarginVertial
• getTertiaryImageRotation
• getTertiaryImageTintAlpha
• getTertiaryImageTintColor
• getTextAlignHorizontal
• getTextAlignVertical
• getTextFormatter
• getTextStyleClipping
• getTextStyleFitting
• getTextStyleWordWrap
• getTextValue
• getTitle
• getViewBaseTexture
• getWeight
• getWhen
• getWidth
• getX
• getY
• isOverflowMaskEnabled
• isToggle
• newShadow
• newShadowWeak
• newState
• newTextValue

Constructors

constructor

• new DThemeDarkButtonColorGradient(backgroundColor?, hover?, pressed?): DThemeDarkButtonColorGradient

Parameters

Name	Type	Default value
backgroundColor	number	0x484848
hover	number	0.017
pressed	number	0.034

Returns

DThemeDarkButtonColorGradient

Inherited from

DThemeDarkButton.constructor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:25

Properties

BACKGROUND_COLOR

• Protected Readonly BACKGROUND_COLOR: number

Inherited from

DThemeDarkButton.BACKGROUND_COLOR

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:19

---

BACKGROUND_COLOR_HOVERED

• Protected Readonly BACKGROUND_COLOR_HOVERED: number

Inherited from

DThemeDarkButton.BACKGROUND_COLOR_HOVERED

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:20

---

BACKGROUND_COLOR_PRESSED

• Protected Readonly BACKGROUND_COLOR_PRESSED: number

Inherited from

DThemeDarkButton.BACKGROUND_COLOR_PRESSED

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:21

---

OUTLINE_COLOR

• Protected Readonly OUTLINE_COLOR: number

Inherited from

DThemeDarkButton.OUTLINE_COLOR

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:23

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getAlpha

Inherited from

DThemeDarkButton.getAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:35

---

getBackgroundAlpha

▸ getBackgroundAlpha(state): number

Returns a background alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getBackgroundAlpha

Inherited from

DThemeDarkButton.getBackgroundAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:84

---

getBackgroundColor

▸ getBackgroundColor(state): null | number

Returns a background color. If the color is null, backgrounds are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Implementation of

DThemeButtonColorGradient.getBackgroundColor

Inherited from

DThemeDarkButton.getBackgroundColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:38

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Implementation of

DThemeButtonColorGradient.getBackgroundTexture

Inherited from

DThemeDarkButton.getBackgroundTexture

Defined in

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

---

getBorderAlign

▸ getBorderAlign(state): number

Returns a border align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getBorderAlign

Inherited from

DThemeDarkButton.getBorderAlign

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:104

---

getBorderAlpha

▸ getBorderAlpha(state): number

Returns a border alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getBorderAlpha

Inherited from

DThemeDarkButton.getBorderAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:96

---

getBorderColor

▸ getBorderColor(state): null | number

Returns a border color. If the color is null, borders are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Implementation of

DThemeButtonColorGradient.getBorderColor

Inherited from

DThemeDarkButton.getBorderColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:60

---

getBorderMask

▸ getBorderMask(state): number

Returns a border mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a mask

Returns

number

Implementation of

DThemeButtonColorGradient.getBorderMask

Inherited from

DThemeDarkButton.getBorderMask

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:108

---

getBorderTexture

▸ getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Implementation of

DThemeButtonColorGradient.getBorderTexture

Inherited from

DThemeDarkButton.getBorderTexture

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:112

---

getBorderWidth

▸ getBorderWidth(state): number

Returns a border width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getBorderWidth

Inherited from

DThemeDarkButton.getBorderWidth

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:100

---

getCheckerColors

▸ getCheckerColors(): [number, number]

Returns

[number, number]

Implementation of

DThemeButtonColorGradient.getCheckerColors

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-color-gradient.ts:40

---

getClearType

▸ getClearType(): number

Returns a clear type. A clear type is for layout classes including DLayoutVertical.

Returns

number

Implementation of

DThemeButtonColorGradient.getClearType

Inherited from

DThemeDarkButton.getClearType

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:167

---

getColor

▸ getColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getColor

Inherited from

DThemeDarkButton.getColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:52

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Implementation of

DThemeButtonColorGradient.getCornerMask

Inherited from

DThemeDarkButton.getCornerMask

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:136

---

getCornerRadius

▸ getCornerRadius(): number

Returns a corner radius.

Returns

number

Implementation of

DThemeButtonColorGradient.getCornerRadius

Inherited from

DThemeDarkButton.getCornerRadius

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:132

---

getCursor

▸ getCursor(state): string

Returns a cursor.

Parameters

Name	Type
state	DBaseStateSet

Returns

string

Implementation of

DThemeButtonColorGradient.getCursor

Inherited from

DThemeDarkButton.getCursor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:126

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Implementation of

DThemeButtonColorGradient.getFontFamilly

Inherited from

DThemeDarkButton.getFontFamilly

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:11

---

getFontSize

▸ getFontSize(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getFontSize

Inherited from

DThemeDarkButton.getFontSize

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:15

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Implementation of

DThemeButtonColorGradient.getFontStyle

Inherited from

DThemeDarkButton.getFontStyle

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:27

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Implementation of

DThemeButtonColorGradient.getFontVariant

Inherited from

DThemeDarkButton.getFontVariant

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:31

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Implementation of

DThemeButtonColorGradient.getFontWeight

Inherited from

DThemeDarkButton.getFontWeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:23

---

getHeight

▸ getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Implementation of

DThemeButtonColorGradient.getHeight

Inherited from

DThemeDarkButton.getHeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:98

---

getImageAlignHorizontal

▸ getImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Implementation of

DThemeButtonColorGradient.getImageAlignHorizontal

Inherited from

DThemeDarkButton.getImageAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:18

---

getImageAlignVertical

▸ getImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Implementation of

DThemeButtonColorGradient.getImageAlignVertical

Inherited from

DThemeDarkButton.getImageAlignVertical

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:22

---

getImageAlignWith

▸ getImageAlignWith(): DAlignWith

Returns

DAlignWith

Implementation of

DThemeButtonColorGradient.getImageAlignWith

Inherited from

DThemeDarkButton.getImageAlignWith

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:26

---

getImageMarginHorizontal

▸ getImageMarginHorizontal(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getImageMarginHorizontal

Inherited from

DThemeDarkButton.getImageMarginHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:30

---

getImageMarginVertial

▸ getImageMarginVertial(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getImageMarginVertial

Inherited from

DThemeDarkButton.getImageMarginVertial

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:34

---

getImageRotation

▸ getImageRotation(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getImageRotation

Inherited from

DThemeDarkButton.getImageRotation

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:46

---

getImageSource

▸ getImageSource(state): null | DisplayObject | Texture

Parameters

Name	Type
state	DBaseStateSet

Returns

null | DisplayObject | Texture

Implementation of

DThemeButtonColorGradient.getImageSource

Inherited from

DThemeDarkButton.getImageSource

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:50

---

getImageTintAlpha

▸ getImageTintAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getImageTintAlpha

Inherited from

DThemeDarkButton.getImageTintAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:42

---

getImageTintColor

▸ getImageTintColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Implementation of

DThemeButtonColorGradient.getImageTintColor

Inherited from

DThemeDarkButton.getImageTintColor

Defined in

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

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Implementation of

DThemeButtonColorGradient.getInteractive

Inherited from

DThemeDarkButton.getInteractive

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:175

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getLineHeight

Inherited from

DThemeDarkButton.getLineHeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:42

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getOutlineAlign

Inherited from

DThemeDarkButton.getOutlineAlign

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:159

---

getOutlineAlpha

▸ getOutlineAlpha(state): number

Returns an outline alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getOutlineAlpha

Inherited from

DThemeDarkButton.getOutlineAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:144

---

getOutlineColor

▸ getOutlineColor(state): null | number

Returns an outline color. If the color is null, outlines are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Implementation of

DThemeButtonColorGradient.getOutlineColor

Inherited from

DThemeDarkButton.getOutlineColor

Defined in

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

---

getOutlineColorActive

▸ getOutlineColorActive(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Inherited from

DThemeDarkButton.getOutlineColorActive

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:75

---

getOutlineColorNonActive

▸ getOutlineColorNonActive(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Inherited from

DThemeDarkButton.getOutlineColorNonActive

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:79

---

getOutlineMask

▸ getOutlineMask(state): number

Returns an outline mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getOutlineMask

Inherited from

DThemeDarkButton.getOutlineMask

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:163

---

getOutlineOffset

▸ getOutlineOffset(state): number

Returns an outline offset.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getOutlineOffset

Inherited from

DThemeDarkButton.getOutlineOffset

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:83

---

getOutlineOffsetActive

▸ getOutlineOffsetActive(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeDarkButton.getOutlineOffsetActive

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:90

---

getOutlineOffsetNonActive

▸ getOutlineOffsetNonActive(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeDarkButton.getOutlineOffsetNonActive

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:94

---

getOutlineWidth

▸ getOutlineWidth(state): number

Returns an outline width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeButtonColorGradient.getOutlineWidth

Inherited from

DThemeDarkButton.getOutlineWidth

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:151

---

getPaddingBottom

▸ getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Implementation of

DThemeButtonColorGradient.getPaddingBottom

Inherited from

DThemeDarkButton.getPaddingBottom

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:128

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Implementation of

DThemeButtonColorGradient.getPaddingLeft

Inherited from

DThemeDarkButton.getPaddingLeft

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:110

---

getPaddingRight

▸ getPaddingRight(): number

Returns a right padding.

Returns

number

Implementation of

DThemeButtonColorGradient.getPaddingRight

Inherited from

DThemeDarkButton.getPaddingRight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:114

---

getPaddingTop

▸ getPaddingTop(): number

Returns a top padding.

Returns

number

Implementation of

DThemeButtonColorGradient.getPaddingTop

Inherited from

DThemeDarkButton.getPaddingTop

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:124

---

getSecondaryImageAlignHorizontal

▸ getSecondaryImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Implementation of

DThemeButtonColorGradient.getSecondaryImageAlignHorizontal

Inherited from

DThemeDarkButton.getSecondaryImageAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:54

---

getSecondaryImageAlignVertical

▸ getSecondaryImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Implementation of

DThemeButtonColorGradient.getSecondaryImageAlignVertical

Inherited from

DThemeDarkButton.getSecondaryImageAlignVertical

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:58

---

getSecondaryImageAlignWith

▸ getSecondaryImageAlignWith(): DAlignWith

Returns

DAlignWith

Implementation of

DThemeButtonColorGradient.getSecondaryImageAlignWith

Inherited from

DThemeDarkButton.getSecondaryImageAlignWith

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:62

---

getSecondaryImageMarginHorizontal

▸ getSecondaryImageMarginHorizontal(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getSecondaryImageMarginHorizontal

Inherited from

DThemeDarkButton.getSecondaryImageMarginHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:66

---

getSecondaryImageMarginVertial

▸ getSecondaryImageMarginVertial(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getSecondaryImageMarginVertial

Inherited from

DThemeDarkButton.getSecondaryImageMarginVertial

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:70

---

getSecondaryImageRotation

▸ getSecondaryImageRotation(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getSecondaryImageRotation

Inherited from

DThemeDarkButton.getSecondaryImageRotation

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:82

---

getSecondaryImageTintAlpha

▸ getSecondaryImageTintAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getSecondaryImageTintAlpha

Inherited from

DThemeDarkButton.getSecondaryImageTintAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:78

---

getSecondaryImageTintColor

▸ getSecondaryImageTintColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Implementation of

DThemeButtonColorGradient.getSecondaryImageTintColor

Inherited from

DThemeDarkButton.getSecondaryImageTintColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:74

---

getShadow

▸ getShadow(): null | DShadow

Returns a shadow. If a shadow is null, no shadow is rendered.

Returns

null | DShadow

Implementation of

DThemeButtonColorGradient.getShadow

Inherited from

DThemeDarkButton.getShadow

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:171

---

getTertiaryImageAlignHorizontal

▸ getTertiaryImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Implementation of

DThemeButtonColorGradient.getTertiaryImageAlignHorizontal

Inherited from

DThemeDarkButton.getTertiaryImageAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:86

---

getTertiaryImageAlignVertical

▸ getTertiaryImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Implementation of

DThemeButtonColorGradient.getTertiaryImageAlignVertical

Inherited from

DThemeDarkButton.getTertiaryImageAlignVertical

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:90

---

getTertiaryImageAlignWith

▸ getTertiaryImageAlignWith(): DAlignWith

Returns

DAlignWith

Implementation of

DThemeButtonColorGradient.getTertiaryImageAlignWith

Inherited from

DThemeDarkButton.getTertiaryImageAlignWith

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:94

---

getTertiaryImageMarginHorizontal

▸ getTertiaryImageMarginHorizontal(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getTertiaryImageMarginHorizontal

Inherited from

DThemeDarkButton.getTertiaryImageMarginHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:98

---

getTertiaryImageMarginVertial

▸ getTertiaryImageMarginVertial(): number

Returns

number

Implementation of

DThemeButtonColorGradient.getTertiaryImageMarginVertial

Inherited from

DThemeDarkButton.getTertiaryImageMarginVertial

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:102

---

getTertiaryImageRotation

▸ getTertiaryImageRotation(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getTertiaryImageRotation

Inherited from

DThemeDarkButton.getTertiaryImageRotation

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:114

---

getTertiaryImageTintAlpha

▸ getTertiaryImageTintAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeButtonColorGradient.getTertiaryImageTintAlpha

Inherited from

DThemeDarkButton.getTertiaryImageTintAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:110

---

getTertiaryImageTintColor

▸ getTertiaryImageTintColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Implementation of

DThemeButtonColorGradient.getTertiaryImageTintColor

Inherited from

DThemeDarkButton.getTertiaryImageTintColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:106

---

getTextAlignHorizontal

▸ getTextAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Implementation of

DThemeButtonColorGradient.getTextAlignHorizontal

Inherited from

DThemeDarkButton.getTextAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:106

---

getTextAlignVertical

▸ getTextAlignVertical(): DAlignVertical

Returns

DAlignVertical

Implementation of

DThemeButtonColorGradient.getTextAlignVertical

Inherited from

DThemeDarkButton.getTextAlignVertical

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:19

---

getTextFormatter

▸ getTextFormatter(): (value: DColorGradientObservable, caller: DButtonColorGradient<DThemeButtonColorGradient, DButtonColorGradientOptions<DThemeButtonColorGradient, any>>) => string

Returns

fn

▸ (value, caller): string

Parameters

Name	Type
value	DColorGradientObservable
caller	DButtonColorGradient<DThemeButtonColorGradient, DButtonColorGradientOptions<DThemeButtonColorGradient, any>>

Returns

string

Implementation of

DThemeButtonColorGradient.getTextFormatter

Overrides

DThemeDarkButton.getTextFormatter

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-color-gradient.ts:32

---

getTextStyleClipping

▸ getTextStyleClipping(): boolean

Returns

boolean

Implementation of

DThemeButtonColorGradient.getTextStyleClipping

Inherited from

DThemeDarkButton.getTextStyleClipping

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:31

---

getTextStyleFitting

▸ getTextStyleFitting(): boolean

Returns

boolean

Implementation of

DThemeButtonColorGradient.getTextStyleFitting

Inherited from

DThemeDarkButton.getTextStyleFitting

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:35

---

getTextStyleWordWrap

▸ getTextStyleWordWrap(): DDynamicTextStyleWordWrap

Returns

DDynamicTextStyleWordWrap

Implementation of

DThemeButtonColorGradient.getTextStyleWordWrap

Inherited from

DThemeDarkButton.getTextStyleWordWrap

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:39

---

getTextValue

▸ getTextValue(state): undefined | DColorGradientObservable

Returns a text value. Called to get a text vale if there is no text value.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

undefined | DColorGradientObservable

Implementation of

DThemeButtonColorGradient.getTextValue

Inherited from

DThemeDarkButton.getTextValue

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:47

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Implementation of

DThemeButtonColorGradient.getTitle

Inherited from

DThemeDarkButton.getTitle

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:183

---

getViewBaseTexture

▸ getViewBaseTexture(): null | Texture

Returns

null | Texture

Implementation of

DThemeButtonColorGradient.getViewBaseTexture

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-color-gradient.ts:28

---

getWeight

▸ getWeight(): number

Returns a weight. Weights are for layout classes including DLayoutVertical. If a weight is less than or equals to zero, layout classes are supposed not to change a width / height.

Returns

number

Implementation of

DThemeButtonColorGradient.getWeight

Inherited from

DThemeDarkButton.getWeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:187

---

getWhen

▸ getWhen(): DButtonBaseWhen

Returns when to activate a button.

Returns

DButtonBaseWhen

Implementation of

DThemeButtonColorGradient.getWhen

Inherited from

DThemeDarkButton.getWhen

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:122

---

getWidth

▸ getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Implementation of

DThemeButtonColorGradient.getWidth

Inherited from

DThemeDarkButton.getWidth

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:102

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeButtonColorGradient.getX

Inherited from

DThemeDarkButton.getX

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:64

---

getY

▸ getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeButtonColorGradient.getY

Inherited from

DThemeDarkButton.getY

Defined in

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

---

isOverflowMaskEnabled

▸ isOverflowMaskEnabled(): boolean

Returns

boolean

Implementation of

DThemeButtonColorGradient.isOverflowMaskEnabled

Inherited from

DThemeDarkButton.isOverflowMaskEnabled

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:27

---

isToggle

▸ isToggle(): boolean

Returns true to turn a toggle mode on.

Returns

boolean

Implementation of

DThemeButtonColorGradient.isToggle

Inherited from

DThemeDarkButton.isToggle

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:118

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Implementation of

DThemeButtonColorGradient.newShadow

Inherited from

DThemeDarkButton.newShadow

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:191

---

newShadowWeak

▸ newShadowWeak(): null | DShadow

Creates a new weak shadow.

Returns

null | DShadow

Implementation of

DThemeButtonColorGradient.newShadowWeak

Inherited from

DThemeDarkButton.newShadowWeak

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:195

---

newState

▸ newState(state): void

Returns true if focusable.

Parameters

Name	Type
state	DBaseStateSet

Returns

void

Implementation of

DThemeButtonColorGradient.newState

Inherited from

DThemeDarkButton.newState

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:179

---

newTextValue

▸ newTextValue(): DStateAwareOrValueMightBe<DColorGradientObservable>

Returns a new text value. Called to initialize a text value if a text value is not given.

Returns

DStateAwareOrValueMightBe<DColorGradientObservable>

Implementation of

DThemeButtonColorGradient.newTextValue

Overrides

DThemeDarkButton.newTextValue

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-color-gradient.ts:36

Edit this page.