Class SingleStatViewProperties

SingleStatViewProperties

Inheritance

System.Object

ViewProperties

SingleStatViewProperties

Implements

IEquatable<SingleStatViewProperties>

Inherited Members

ViewProperties.Equals(ViewProperties)

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class SingleStatViewProperties : ViewProperties, IEquatable<SingleStatViewProperties>

Constructors

SingleStatViewProperties()

Initializes a new instance of the SingleStatViewProperties class.

Declaration

protected SingleStatViewProperties()

SingleStatViewProperties(SingleStatViewProperties.TypeEnum, List<DashboardQuery>, List<DashboardColor>, SingleStatViewProperties.ShapeEnum, String, Nullable<Boolean>, String, String, String, String, StaticLegend, DecimalPlaces)

Initializes a new instance of the SingleStatViewProperties class.

Declaration

public SingleStatViewProperties(SingleStatViewProperties.TypeEnum type = default(SingleStatViewProperties.TypeEnum), List<DashboardQuery> queries = null, List<DashboardColor> colors = null, SingleStatViewProperties.ShapeEnum shape = default(SingleStatViewProperties.ShapeEnum), string note = null, bool? showNoteWhenEmpty = null, string prefix = null, string tickPrefix = null, string suffix = null, string tickSuffix = null, StaticLegend staticLegend = null, DecimalPlaces decimalPlaces = null)

Parameters

Type	Name	Description
SingleStatViewProperties.TypeEnum	type	type (required) (default to TypeEnum.SingleStat).
List<DashboardQuery>	queries	queries (required).
List<DashboardColor>	colors	Colors define color encoding of data into a visualization (required).
SingleStatViewProperties.ShapeEnum	shape	shape (required) (default to ShapeEnum.ChronografV2).
System.String	note	note (required).
System.Nullable<System.Boolean>	showNoteWhenEmpty	If true, will display note when empty (required).
System.String	prefix	prefix (required).
System.String	tickPrefix	tickPrefix (required).
System.String	suffix	suffix (required).
System.String	tickSuffix	tickSuffix (required).
StaticLegend	staticLegend	staticLegend.
DecimalPlaces	decimalPlaces	decimalPlaces (required).

Properties

Colors

Colors define color encoding of data into a visualization

Declaration

public List<DashboardColor> Colors { get; set; }

Property Value

Type	Description
List<DashboardColor>	Colors define color encoding of data into a visualization

DecimalPlaces

Gets or Sets DecimalPlaces

Declaration

public DecimalPlaces DecimalPlaces { get; set; }

Property Value

Type	Description
DecimalPlaces

Note

Gets or Sets Note

Declaration

public string Note { get; set; }

Property Value

Type	Description
System.String

Prefix

Gets or Sets Prefix

Declaration

public string Prefix { get; set; }

Property Value

Type	Description
System.String

Queries

Gets or Sets Queries

Declaration

public List<DashboardQuery> Queries { get; set; }

Property Value

Type	Description
List<DashboardQuery>

Shape

Gets or Sets Shape

Declaration

public SingleStatViewProperties.ShapeEnum Shape { get; set; }

Property Value

Type	Description
SingleStatViewProperties.ShapeEnum

ShowNoteWhenEmpty

If true, will display note when empty

Declaration

public bool? ShowNoteWhenEmpty { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	If true, will display note when empty

StaticLegend

Gets or Sets StaticLegend

Declaration

public StaticLegend StaticLegend { get; set; }

Property Value

Type	Description
StaticLegend

Suffix

Gets or Sets Suffix

Declaration

public string Suffix { get; set; }

Property Value

Type	Description
System.String

TickPrefix

Gets or Sets TickPrefix

Declaration

public string TickPrefix { get; set; }

Property Value

Type	Description
System.String

TickSuffix

Gets or Sets TickSuffix

Declaration

public string TickSuffix { get; set; }

Property Value

Type	Description
System.String

Type

Gets or Sets Type

Declaration

public SingleStatViewProperties.TypeEnum Type { get; set; }

Property Value

Type	Description
SingleStatViewProperties.TypeEnum

Methods

Equals(SingleStatViewProperties)

Returns true if SingleStatViewProperties instances are equal

Declaration

public bool Equals(SingleStatViewProperties input)

Parameters

Type	Name	Description
SingleStatViewProperties	input	Instance of SingleStatViewProperties 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

Overrides

ViewProperties.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

Overrides

ViewProperties.GetHashCode()

ToJson()

Returns the JSON string presentation of the object

Declaration

public override string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object

Overrides

ViewProperties.ToJson()

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
System.String	String presentation of the object

Overrides

ViewProperties.ToString()

Implements

IEquatable<>