ConstructColorRamp(ColorRampAlgorithm,CIMColor,CIMColor) Method

In This Topic

Construct a color ramp using the specified algorithm. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

CIMColorRamp ConstructColorRamp( 
   ColorRampAlgorithm algorithm,
   CIMColor fromColor,
   CIMColor toColor
)

Overloads Function ConstructColorRamp( _
   ByVal algorithm As ColorRampAlgorithm, _
   ByVal fromColor As CIMColor, _
   ByVal toColor As CIMColor _
) As CIMColorRamp

Parameters

algorithm: ColorRampAlgorithm
fromColor: The from color
toColor: The to color

Return Value

CIMColorRamp

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	fromColor
System.ArgumentNullException	toColor

Remarks

From and to colors are ignored for ColorRampAlgorithm.Fixed. For ColorRampAlgorithm.RandomHSV the fromColor acts as the minimum, the toColor acts as the maximum. From and to colors are converted to HSV.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

IColorFactory Interface
IColorFactory Members
Overload List

Send feedback