Skip to content

ColorCloudClient

Namespace: ThinkGeo.Core

A class provides the methods to access the ColorUtilities APIs.

public class ColorCloudClient : CloudClient, System.IDisposable

Inheritance ObjectCloudClientColorCloudClient
Implements IDisposable

Remarks:

A class provides the methods to access the ColorUtilities APIs.

Properties

TimeoutInSeconds

The request timeout, default 100 seconds

public int TimeoutInSeconds { get; set; }

Property Value

Int32

WebProxy

The proxy used for requesting a Web Response.

public IWebProxy WebProxy { get; set; }

Property Value

IWebProxy

ClientId

A GIS Server NativeConfidential client ID.

public string ClientId { get; set; }

Property Value

String

ClientSecret

A GIS Server NativeConfidential client secret.

public string ClientSecret { get; set; }

Property Value

String

BaseUris

Candidate Gis Server Uris. This collection must have one uri at least before sending any request.

public Collection<Uri> BaseUris { get; }

Property Value

Collection<Uri>

Constructors

ColorCloudClient()

Initilizes an instance. You need apply client Id and secret by properties.

public ColorCloudClient()

ColorCloudClient(String, String)

Initializes an instance with ClientID and ClientSecret. It will send a request to GIS Server to gain the token which will be added to the Header for all the requests.

public ColorCloudClient(string clientId, string clientSecret)

Parameters

clientId String
The ClientID for the auth.

clientSecret String
The ClientSecret for the auth.

Exceptions

ArgumentNullException
Thrown when the or is null.

Methods

GetColorsInAnalogousFamily(Int32)

Generats an "analogous family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInAnalogousFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
An "analogous family" of colors.

GetColorsInAnalogousFamilyAsync(Int32)

Generats an "analogous family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInAnalogousFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
An "analogous family" of colors.

GetColorsInAnalogousFamily(GeoColor, Int32)

Generats an "analogous family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInAnalogousFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
An "analogous family" of colors.

GetColorsInAnalogousFamilyAsync(GeoColor, Int32)

Generats an "analogous family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInAnalogousFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
An "analogous family" of colors.

GetColorsInComplementaryFamily(Int32)

Generats a "complementary family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInComplementaryFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "complementary family" of colors.

GetColorsInComplementaryFamilyAsync(Int32)

Generats a "complementary family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInComplementaryFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "complementary family" of colors.

GetColorsInComplementaryFamily(GeoColor, Int32)

Generats a "complementary family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInComplementaryFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "complementary family" of colors.

GetColorsInComplementaryFamilyAsync(GeoColor, Int32)

Generats a "complementary family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInComplementaryFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "complementary family" of colors.

GetColorsInContrastingFamily(Int32)

Generats a "Contrasting family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInContrastingFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "Contrasting family" of colors.

GetColorsInContrastingFamilyAsync(Int32)

Generats a "Contrasting family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInContrastingFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "Contrasting family" of colors.

GetColorsInContrastingFamily(GeoColor, Int32)

Generats a "contrasting family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInContrastingFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "contrasting family" of colors.

GetColorsInContrastingFamilyAsync(GeoColor, Int32)

Generats a "contrasting family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInContrastingFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "contrasting family" of colors.

GetColorsInHueFamily(Int32)

Generats a "hue family" of colors by an input color.

public Collection<GeoColor> GetColorsInHueFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Collection<GeoColor>
A "hue family" of colors.

GetColorsInHueFamilyAsync(Int32)

Generats a "hue family" of colors by an input color.

public Task<Collection<GeoColor>> GetColorsInHueFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Collection<GeoColor>>
A "hue family" of colors.

GetColorsInHueFamily(GeoColor, Int32)

Generats a "hue family" of colors by an input color.

public Collection<GeoColor> GetColorsInHueFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Collection<GeoColor>
A "hue family" of colors.

GetColorsInHueFamilyAsync(GeoColor, Int32)

Generats a "hue family" of colors by an input color.

public Task<Collection<GeoColor>> GetColorsInHueFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Collection<GeoColor>>
A "hue family" of colors.

GetColorsInQualityFamily(Int32)

Generats a "quality family" of colors by an input color.

public Collection<GeoColor> GetColorsInQualityFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Collection<GeoColor>
A "quality family" of colors.

GetColorsInQualityFamilyAsync(Int32)

Generats a "quality family" of colors by an input color.

public Task<Collection<GeoColor>> GetColorsInQualityFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Collection<GeoColor>>
A "quality family" of colors.

GetColorsInQualityFamily(GeoColor, Int32)

Generats a "quality family" of colors by an input color.

public Collection<GeoColor> GetColorsInQualityFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Collection<GeoColor>
A "quality family" of colors.

GetColorsInQualityFamilyAsync(GeoColor, Int32)

Generats a "quality family" of colors by an input color.

public Task<Collection<GeoColor>> GetColorsInQualityFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Collection<GeoColor>>
A "quality family" of colors.

GetColorsInTetradFamily(Int32)

Generats a "tetrad family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInTetradFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "tetrad family" of colors.

GetColorsInTetradFamilyAsync(Int32)

Generats a "tetrad family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInTetradFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "tetrad family" of colors.

GetColorsInTetradFamily(GeoColor, Int32)

Generats a "tetrad family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInTetradFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "tetrad family" of colors.

GetColorsInTetradFamilyAsync(GeoColor, Int32)

Generats a "tetrad family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInTetradFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "tetrad family" of colors.

GetColorsInTriadFamily(Int32)

Generats a "triad family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInTriadFamily(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "triad family" of colors.

GetColorsInTriadFamilyAsync(Int32)

Generats a "triad family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInTriadFamilyAsync(int numberOfColors)

Parameters

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "triad family" of colors.

GetColorsInTriadFamily(GeoColor, Int32)

Generats a "triad family" of colors by an input color.

public Dictionary<GeoColor, Collection<GeoColor>> GetColorsInTriadFamily(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Dictionary<GeoColor, Collection<GeoColor>>
A "triad family" of colors.

GetColorsInTriadFamilyAsync(GeoColor, Int32)

Generats a "triad family" of colors by an input color.

public Task<Dictionary<GeoColor, Collection<GeoColor>>> GetColorsInTriadFamilyAsync(GeoColor color, int numberOfColors)

Parameters

color GeoColor
Input color.

numberOfColors Int32
A number of output colors desired.

Returns

Task<Dictionary<GeoColor, Collection<GeoColor>>>
A "triad family" of colors.

Events

GettingAccessToken

Occurs before getting an AccessToken.

public event EventHandler<GettingAccessTokenEventArgs> GettingAccessToken;

SendingWebRequest

Occurs before sending a web request.

public event EventHandler<SendingWebRequestEventArgs> SendingWebRequest;

SentWebRequest

Occurs after the response of a web request is gotten.

public event EventHandler<SentWebRequestEventArgs> SentWebRequest;