1. Home
  2. .Background.BackgroundPredominantGradientQualifier

new BackgroundPredominantGradientQualifier()

Description

Specifies that the gradient fade effect, used for the background when resizing with padding, uses the predominant colors in the whole of the image.

Details

Qualifiers.Background.BaseGradientBackground

qualifiers/background/shared/gradient/BackgroundPredominantGradientQualifier.ts, line 9

Methods

toString()

Description

Stringify the qualifier BackgroundQualifiers don't have a value, but instead override the toString() function.

Details

qualifiers/background/shared/gradient/BackgroundPredominantGradientQualifier.ts, line 15

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.BaseGradientBackground#gradientColors

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.BaseGradientBackground#gradientDirection

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