1. Home
  2. .Background.BaseGradientBackground

new BaseGradientBackground()

Description

Defines the gradient fade effect to use for the background when resizing with padding.

Details

Qualifiers.Background.BaseCommonBackground

qualifiers/background/shared/base/BaseGradientBackground.ts, line 8

Methods

gradientColors( num ) → {this}

Description

Sets the number of predominant colors to use (2 or 4).

Parameters
Name Type Description
num number
Returns
Details

qualifiers/background/shared/base/BaseGradientBackground.ts, line 15

contrast() → {this}

Description

Selects the strongest contrasting color to use for padding.

Returns
Details

Qualifiers.Background.BaseCommonBackground#contrast

qualifiers/background/shared/base/BaseCommonBackground.ts, line 18

gradientDirection( direction ) → {this}

Description

Sets the direction for a background gradient fade effect.

Parameters
Name Type Description
direction Qualifiers.GradientDirection | GradientDirectionType | string

Use one of these functions provided by GradientDirection
Returns
Details

qualifiers/background/shared/base/BaseGradientBackground.ts, line 25

palette( ...colors ) → {this}

Description

Defines the custom colors to use when resizing using content-aware padding.

Parameters
Name Type Attributes Description
colors string <repeatable>

One or more colors - Example: palette('green', 'red', blue')
Returns
Details

Qualifiers.Background.BaseCommonBackground#palette

qualifiers/background/shared/base/BaseCommonBackground.ts, line 27