User Tools

Site Tools


api:thinkgeo.mapsuite.drawing.geocolor

ThinkGeo.MapSuite.Drawing.GeoColor

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Drawing.GeoColor

Members Summary

Public Constructors

GeoColor()

  • N/A
Remarks
  • N/A
Parameters

GeoColor(Int32,Int32,Int32)

  • This constructor creates a new color.
Remarks
  • None
Parameters
  • 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.
Remarks
  • None
Parameters
  • 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.
Remarks
  • You can use this overload to create a transparent version of another color.
Parameters
  • 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.

Protected Constructors

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

  • N/A
Remarks
  • N/A
Parameters
  • name
    • Type:String
    • 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

Public Methods

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • None
Return Value
  • Type:Boolean
  • Description:This method returns the Equals functionality.
Parameters
  • obj
    • Type:Object
    • Description:This parameter is the object you want to check to see if it is equal to the current instance.

GetHashCode()

  • N/A
Remarks
  • None
Return Value
  • Type:Int32
  • Description:This method returns the hash code.
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

GetColorsInHueFamily(GeoColor,Int32)

  • N/A
Remarks
  • 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.
Return Value
  • Type:Collection<GeoColor>
  • Description:This method returns a collection of GeoColors based on the same hue that is passed in.
Parameters
  • 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)

  • N/A
Remarks
  • 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.
Return Value
  • Type:Collection<GeoColor>
  • Description:This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.
Parameters
  • 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
Remarks
  • N/A
Return Value
  • Type:Collection<GeoColor>
  • Description:N/A
Parameters
  • fromColor
  • numberOfColors
    • Type:Int32
    • Description:N/A

FromArgb(Int32,Int32,Int32,Int32)

  • N/A
Remarks
  • None
Return Value
  • Type:GeoColor
  • Description:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
Parameters
  • 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)

  • N/A
Remarks
  • N/A
Return Value
  • Type:GeoColor
  • Description:You can use this overload to create a transparent version of another color.
Parameters
  • 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)

  • N/A
Remarks
  • None
Return Value
Parameters
  • 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)

  • N/A
Remarks
  • None
Return Value
  • Type:GeoColor
  • Description:This method returns a GeoColor from an OLE color.
Parameters
  • oleColor
    • Type:Int32
    • Description:This parameter represents the OLE color you want to convert.

FromHtml(String)

  • N/A
Remarks
  • None
Return Value
  • Type:GeoColor
  • Description:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
Parameters
  • htmlColor
    • Type:String
    • Description:This parameter represents the HTML color that you want to convert.

GetRandomGeoColor(RandomColorType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:GeoColor
  • Description:A GeoColor structure the method created.
Parameters
  • colorType

GetRandomGeoColor(Int32,RandomColorType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:GeoColor
  • Description:A GeoColor structure the method created.
Parameters
  • alpha
    • Type:Int32
    • Description:The alpha component. Valid values are 0 through 255.
  • colorType

FromWin32(Int32)

  • N/A
Remarks
  • None
Return Value
  • Type:GeoColor
  • Description:This method returns a GeoColor from a Win32 color.
Parameters
  • win32Color
    • Type:Int32
    • Description:This parameter represents the Win32 color you want to convert.

ToOle(GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:Int32
  • Description:This method returns an OLE color from a GeoColor.
Parameters
  • color
    • Type:GeoColor
    • Description:This parameter represents the GeoColor you want to convert.

ToHtml(GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:String
  • Description:This method returns an HTML color from a GeoColor.
Parameters
  • color
    • Type:GeoColor
    • Description:This parameter represents the GeoColor you want to convert.

ToWin32(GeoColor)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:This method returns a Win32 color from a GeoColor.
Parameters
  • color
    • Type:GeoColor
    • Description:This parameter represents the GeoColor you want to convert.

Protected Methods

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

IsTransparent

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

HtmlColor

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

Ahsl

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

Argb

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

AlphaComponent

  • N/A
Remarks
  • None
Return Value
  • Type:Byte

RedComponent

  • N/A
Remarks
  • None
Return Value
  • Type:Byte

GreenComponent

  • N/A
Remarks
  • None
Return Value
  • Type:Byte

BlueComponent

  • N/A
Remarks
  • None
Return Value
  • Type:Byte

Hue

  • N/A
Remarks
  • None
Return Value
  • Type:Single

Saturation

  • N/A
Remarks
  • None
Return Value
  • Type:Single

Luminance

  • N/A
Remarks
  • None
Return Value
  • Type:Single

Protected Properties

NameAndARGBValue

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

Public Events

api/thinkgeo.mapsuite.drawing.geocolor.txt · Last modified: 2017/01/11 06:51 (external edit)