ThinkGeo.MapSuite.Core.GeoColor

This structure represents a color for drawing on a GeoCanvas.

• System.Object
  • System.ValueType
    • ThinkGeo.MapSuite.Core.GeoColor

GeoColor(Int32,Int32,Int32)

• This constructor creates a new color.

• None

• red
  • Type:Int32
  • Description:This parameter specifies the red component of the color.

• green
  • Type:Int32
  • Description:This parameter specifies the green component of the color.

• blue
  • Type:Int32
  • Description:This parameter specifies the blue component of the color.

GeoColor(Int32,Int32,Int32,Int32)

• This constructor creates a new color.

• None

• alpha
  • Type:Int32
  • Description:This parameter specifies the alpha, or transparent, component of the color.

• red
  • Type:Int32
  • Description:This parameter specifies the red component of the color.

• green
  • Type:Int32
  • Description:This parameter specifies the green component of the color.

• blue
  • Type:Int32
  • Description:This parameter specifies the blue component of the color.

GeoColor(Int32,GeoColor)

• This constructor creates a new color.

• You can use this overload to create a transparent version of another color.

• alpha
  • Type:Int32
  • Description:This parameter specifies the alpha component. An alpha of 0 is totally transparent.

• color
  • Type:GeoColor
  • Description:This parameter specifies the base color.

GeoColor(String,ColorType,Int32,Int32,Int32,Int32)

• N/A

• N/A

• name
  • Type:String
  • Description:N/A

• colorType
  • Type:ColorType
  • Description:N/A

• alpha
  • Type:Int32
  • Description:N/A

• red
  • Type:Int32
  • Description:N/A

• green
  • Type:Int32
  • Description:N/A

• blue
  • Type:Int32
  • Description:N/A

Equals(Object)

• This method is an override of the Equals functionality.

• None

• Type:Boolean
• Description:This method returns the Equals functionality.

• obj
  • Type:Object
  • Description:This parameter is the object you want to check to see if it is equal to the current instance.

GetHashCode()

• This method is an override of the GetHashCode functionality.

• None

• Type:Int32
• Description:This method returns the hash code.

ToString()

• N/A

• N/A

• Type:String
• Description:N/A

GetType()

• N/A

• N/A

• Type:Type
• Description:N/A

GetColorsInHueFamily(GeoColor,Int32)

• This method returns a collection of GeoColors based on the same hue that is passed in.

• This method is useful when you want to get a number of colors that have the same hue. For example, you can use this in maps that represent class breaks. If you passed in a red hue, then the method would return variations such as light red, dark red, pastel red, etc.

• Type:Collection<GeoColor>
• Description:This method returns a collection of GeoColors based on the same hue that is passed in.

• baseColor
  • Type:GeoColor
  • Description:This parameter is the color on which you want to base the color collection.

• numbersOfColors
  • Type:Int32
  • Description:This parameter represents the number of colors you want returned from the method.

GetColorsInQualityFamily(GeoColor,Int32)

• This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.

• This method is useful when you want to get a number of different colors that have the same quality. For example, you can use this in maps that represent countries or connected places. If you passed in bright red, then the method would return variants such as bright blue, bright green, etc. If you passed in dark red, you would get dark blue, dark green, etc.

• Type:Collection<GeoColor>
• Description:This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.

• baseColor
  • Type:GeoColor
  • Description:This parameter is the color on which you want to base the color collection.

• numberOfColors
  • Type:Int32
  • Description:This parameter represents the number of colors you want returned from the method.

GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection)

• N/A

• N/A

• Type:Collection<GeoColor>
• Description:N/A

• fromColor
  • Type:GeoColor
  • Description:N/A

• toColor
  • Type:GeoColor
  • Description:N/A

• numberOfColors
  • Type:Int32
  • Description:N/A

• colorWheelDirection
  • Type:ColorWheelDirection
  • Description:N/A

FromArgb(Int32,Int32,Int32,Int32)

• This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.

• None

• Type:GeoColor
• Description:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.

• alpha
  • Type:Int32
  • Description:This parameter specifies the alpha, or transparent, component of the color.

• red
  • Type:Int32
  • Description:This parameter specifies the red component of the color.

• green
  • Type:Int32
  • Description:This parameter specifies the green component of the color.

• blue
  • Type:Int32
  • Description:This parameter specifies the blue component of the color.

FromArgb(Int32,GeoColor)

• This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.

• N/A

• Type:GeoColor
• Description:You can use this overload to create a transparent version of another color.

• alpha
  • Type:Int32
  • Description:This parameter determines how transparent the color is. An alpha of 0 means it is totally transparent.

• baseColor
  • Type:GeoColor
  • Description:This parameter is the color you want to apply the transparency to.

FromAhsl(Int32,Single,Single,Single)

• This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components.

• None

• Type:GeoColor
• Description:N/A

• alpha
  • Type:Int32
  • Description:This parameter specifies the alpha, or transparent, component of the color.

• hue
  • Type:Single
  • Description:This parameter specifies the hue component of the color.

• saturation
  • Type:Single
  • Description:This parameter specifies the saturation component of the color.

• luminance
  • Type:Single
  • Description:This parameter specifies the luminance component of the color.

FromOle(Int32)

• This method returns a GeoColor from an OLE color.

• None

• Type:GeoColor
• Description:This method returns a GeoColor from an OLE color.

• oleColor
  • Type:Int32
  • Description:This parameter represents the OLE color you want to convert.

FromHtml(String)

• This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).

• None

• Type:GeoColor
• Description:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).

• htmlColor
  • Type:String
  • Description:This parameter represents the HTML color that you want to convert.

GetRandomGeoColor(RandomColorType)

• Creates a random GeoColor structure based on the specific ColorType

• N/A

• Type:GeoColor
• Description:A GeoColor structure the method created.

• colorType
  • Type:RandomColorType
  • Description:A ColorType defines types of color.

GetRandomGeoColor(Int32,RandomColorType)

• Creates a random GeoColor structure

• N/A

• Type:GeoColor
• Description:A GeoColor structure the method created.

• alpha
  • Type:Int32
  • Description:The alpha component. Valid values are 0 through 255.

• colorType
  • Type:RandomColorType
  • Description:A ColorType defines types of color.

FromWin32(Int32)

• This method returns a GeoColor from a Win32 color.

• None

• Type:GeoColor
• Description:This method returns a GeoColor from a Win32 color.

• win32Color
  • Type:Int32
  • Description:This parameter represents the Win32 color you want to convert.

ToOle(GeoColor)

• This method returns an OLE color from a GeoColor.

• None

• Type:Int32
• Description:This method returns an OLE color from a GeoColor.

• color
  • Type:GeoColor
  • Description:This parameter represents the GeoColor you want to convert.

ToHtml(GeoColor)

• This method returns an HTML color from a GeoColor.

• None

• Type:String
• Description:This method returns an HTML color from a GeoColor.

• color
  • Type:GeoColor
  • Description:This parameter represents the GeoColor you want to convert.

ToWin32(GeoColor)

• This method returns a Win32 color from a GeoColor.

• N/A

• Type:Int32
• Description:This method returns a Win32 color from a GeoColor.

• color
  • Type:GeoColor
  • Description:This parameter represents the GeoColor you want to convert.

Finalize()

• N/A

• N/A

• Type:Void
• Description:N/A

MemberwiseClone()

• N/A

• N/A

• Type:Object
• Description:N/A

IsTransparent

Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0.

N/A

• Type:Boolean

AlphaComponent

This property returns the alpha component of the GeoColor.

None

• Type:Byte

RedComponent

This property returns the red component of the GeoColor.

None

• Type:Byte

GreenComponent

This property returns the green component of the GeoColor.

None

• Type:Byte

BlueComponent

This property returns the blue component of the GeoColor.

None

• Type:Byte

Hue

This property returns the hue component of the GeoColor.

None

• Type:Single

Saturation

This property returns the saturation component of the GeoColor.

None

• Type:Single

Luminance

This property returns the luminance component of the GeoColor.

None

• Type:Single