Class ColorDistribution

Specifies a color as a distribution, which can include a constant color, random color range or a color gradient.

Hierarchy

FrameworkObject
- ColorDistribution

Index

Constructors

Accessors

distributionType

Methods

getMaxConstant getMaxGradient getMinConstant getMinGradient

Constructors

constructor

new ColorDistribution(options?, isInternalConstructor?): ColorDistribution
Creates a new distribution that returns a constant color.
Parameters
- Optionaloptions:
      | {
          color: Immutable<Color>;
      }
      | {
          maxColor: Immutable<Color>;
          minColor: Immutable<Color>;
      }
      | {
          gradient: ColorGradient;
      }
      | {
          maxGradient: ColorGradient;
          minGradient: ColorGradient;
      }
  Options object for the function call.
- OptionalisInternalConstructor: boolean
Returns ColorDistribution
Overrides FrameworkObject.constructor

Accessors

distributionType

get distributionType(): EnumValue<PropertyDistributionType, number>
Returns the type of the represented distribution.

Returns EnumValue<PropertyDistributionType, number>

Methods

getMaxConstant

getMaxConstant(): Color
Returns the maximum value of a constant range. Only defined if the distribution represents a non-gradient range.

Returns Color

getMaxGradient

getMaxGradient(): ColorGradient
Returns the curve representing the second gradient of a gradient range. Only defined if the distribution represents a gradient range.

Returns ColorGradient

getMinConstant

getMinConstant(): Color
Returns the constant value of the distribution, or the minimal value of a constant range. Undefined if the distribution is represented by a gradient.

Returns Color

getMinGradient

getMinGradient(): ColorGradient
Returns the gradient representing the distribution, or the first gradient representing a gradient range. Undefined if the distribution is represented by a constant or a non-gradient range.

Returns ColorGradient