Class HistogramViewProperties

HistogramViewProperties

Inheritance

System.Object

ViewProperties

HistogramViewProperties

Implements

IEquatable<HistogramViewProperties>

Inherited Members

ViewProperties.Equals(ViewProperties)

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class HistogramViewProperties : ViewProperties, IEquatable<HistogramViewProperties>

Constructors

HistogramViewProperties()

Initializes a new instance of the HistogramViewProperties class.

Declaration

protected HistogramViewProperties()

HistogramViewProperties(HistogramViewProperties.TypeEnum, List<DashboardQuery>, List<DashboardColor>, HistogramViewProperties.ShapeEnum, String, Nullable<Boolean>, String, List<String>, List<Nullable<Single>>, String, HistogramViewProperties.PositionEnum, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, Nullable<Int32>)

Initializes a new instance of the HistogramViewProperties class.

Declaration

public HistogramViewProperties(HistogramViewProperties.TypeEnum type = default(HistogramViewProperties.TypeEnum), List<DashboardQuery> queries = null, List<DashboardColor> colors = null, HistogramViewProperties.ShapeEnum shape = default(HistogramViewProperties.ShapeEnum), string note = null, bool? showNoteWhenEmpty = null, string xColumn = null, List<string> fillColumns = null, List<float?> xDomain = null, string xAxisLabel = null, HistogramViewProperties.PositionEnum position = (HistogramViewProperties.PositionEnum)0, int? binCount = null, bool? legendColorizeRows = null, bool? legendHide = null, float? legendOpacity = null, int? legendOrientationThreshold = null)

Parameters

Type	Name	Description
HistogramViewProperties.TypeEnum	type	type (required) (default to TypeEnum.Histogram).
List<DashboardQuery>	queries	queries (required).
List<DashboardColor>	colors	Colors define color encoding of data into a visualization (required).
HistogramViewProperties.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	xColumn	xColumn (required).
List<System.String>	fillColumns	fillColumns (required).
List<System.Nullable<System.Single>>	xDomain	xDomain (required).
System.String	xAxisLabel	xAxisLabel (required).
HistogramViewProperties.PositionEnum	position	position (required).
System.Nullable<System.Int32>	binCount	binCount (required).
System.Nullable<System.Boolean>	legendColorizeRows	legendColorizeRows.
System.Nullable<System.Boolean>	legendHide	legendHide.
System.Nullable<System.Single>	legendOpacity	legendOpacity.
System.Nullable<System.Int32>	legendOrientationThreshold	legendOrientationThreshold.

Properties

BinCount

Gets or Sets BinCount

Declaration

public int? BinCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

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

FillColumns

Gets or Sets FillColumns

Declaration

public List<string> FillColumns { get; set; }

Property Value

Type	Description
List<System.String>

LegendColorizeRows

Gets or Sets LegendColorizeRows

Declaration

public bool? LegendColorizeRows { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LegendHide

Gets or Sets LegendHide

Declaration

public bool? LegendHide { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LegendOpacity

Gets or Sets LegendOpacity

Declaration

public float? LegendOpacity { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

LegendOrientationThreshold

Gets or Sets LegendOrientationThreshold

Declaration

public int? LegendOrientationThreshold { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Note

Gets or Sets Note

Declaration

public string Note { get; set; }

Property Value

Type	Description
System.String

Position

Gets or Sets Position

Declaration

public HistogramViewProperties.PositionEnum Position { get; set; }

Property Value

Type	Description
HistogramViewProperties.PositionEnum

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 HistogramViewProperties.ShapeEnum Shape { get; set; }

Property Value

Type	Description
HistogramViewProperties.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

Type

Gets or Sets Type

Declaration

public HistogramViewProperties.TypeEnum Type { get; set; }

Property Value

Type	Description
HistogramViewProperties.TypeEnum

XAxisLabel

Gets or Sets XAxisLabel

Declaration

public string XAxisLabel { get; set; }

Property Value

Type	Description
System.String

XColumn

Gets or Sets XColumn

Declaration

public string XColumn { get; set; }

Property Value

Type	Description
System.String

XDomain

Gets or Sets XDomain

Declaration

public List<float?> XDomain { get; set; }

Property Value

Type	Description
List<System.Nullable<System.Single>>

Methods

Equals(HistogramViewProperties)

Returns true if HistogramViewProperties instances are equal

Declaration

public bool Equals(HistogramViewProperties input)

Parameters

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