Class DashboardColor

Defines an encoding of data value into color space.

Inheritance

System.Object

DashboardColor

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class DashboardColor : IEquatable<DashboardColor>

Constructors

DashboardColor()

Initializes a new instance of the DashboardColor class.

Declaration

protected DashboardColor()

DashboardColor(String, DashboardColor.TypeEnum, String, String, Nullable<Single>)

Initializes a new instance of the DashboardColor class.

Declaration

public DashboardColor(string id = null, DashboardColor.TypeEnum type = (DashboardColor.TypeEnum)0, string hex = null, string name = null, float? value = null)

Parameters

Type	Name	Description
System.String	id	The unique ID of the view color. (required).
DashboardColor.TypeEnum	type	Type is how the color is used. (required).
System.String	hex	The hex number of the color (required).
System.String	name	The user-facing name of the hex color. (required).
System.Nullable<System.Single>	value	The data value mapped to this color. (required).

Properties

Hex

The hex number of the color

Declaration

public string Hex { get; set; }

Property Value

Type	Description
System.String	The hex number of the color

Id

The unique ID of the view color.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String	The unique ID of the view color.

Name

The user-facing name of the hex color.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The user-facing name of the hex color.

Type

Type is how the color is used.

Declaration

public DashboardColor.TypeEnum Type { get; set; }

Property Value

Type	Description
DashboardColor.TypeEnum	Type is how the color is used.

Value

The data value mapped to this color.

Declaration

public float? Value { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The data value mapped to this color.

Methods

Equals(DashboardColor)

Returns true if DashboardColor instances are equal

Declaration

public bool Equals(DashboardColor input)

Parameters

Type	Name	Description
DashboardColor	input	Instance of DashboardColor to be compared

Returns

Type	Description
System.Boolean	Boolean

Equals(Object)

Returns true if objects are equal

Declaration

public override bool Equals(object input)

Parameters

Type	Name	Description
System.Object	input	Object to be compared

Returns

Type	Description
System.Boolean	Boolean

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
System.String	String presentation of the object