Class HeatmapViewProperties

HeatmapViewProperties

Inheritance

System.Object

ViewProperties

HeatmapViewProperties

Implements

IEquatable<HeatmapViewProperties>

Inherited Members

ViewProperties.Equals(ViewProperties)

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class HeatmapViewProperties : ViewProperties, IEquatable<HeatmapViewProperties>

Constructors

HeatmapViewProperties()

Initializes a new instance of the HeatmapViewProperties class.

Declaration

protected HeatmapViewProperties()

HeatmapViewProperties(String, HeatmapViewProperties.TypeEnum, List<DashboardQuery>, List<String>, HeatmapViewProperties.ShapeEnum, String, Nullable<Boolean>, String, List<String>, Nullable<Int32>, Nullable<Single>, Nullable<Single>, String, List<String>, Nullable<Int32>, Nullable<Single>, Nullable<Single>, List<Nullable<Decimal>>, List<Nullable<Decimal>>, String, String, String, String, String, String, Nullable<Decimal>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, Nullable<Int32>)

Initializes a new instance of the HeatmapViewProperties class.

Declaration

public HeatmapViewProperties(string timeFormat = null, HeatmapViewProperties.TypeEnum type = default(HeatmapViewProperties.TypeEnum), List<DashboardQuery> queries = null, List<string> colors = null, HeatmapViewProperties.ShapeEnum shape = default(HeatmapViewProperties.ShapeEnum), string note = null, bool? showNoteWhenEmpty = null, string xColumn = null, List<string> generateXAxisTicks = null, int? xTotalTicks = null, float? xTickStart = null, float? xTickStep = null, string yColumn = null, List<string> generateYAxisTicks = null, int? yTotalTicks = null, float? yTickStart = null, float? yTickStep = null, List<decimal?> xDomain = null, List<decimal?> yDomain = null, string xAxisLabel = null, string yAxisLabel = null, string xPrefix = null, string xSuffix = null, string yPrefix = null, string ySuffix = null, decimal? binSize = null, bool? legendColorizeRows = null, bool? legendHide = null, float? legendOpacity = null, int? legendOrientationThreshold = null)

Parameters

Type	Name	Description
System.String	timeFormat	timeFormat.
HeatmapViewProperties.TypeEnum	type	type (required) (default to TypeEnum.Heatmap).
List<DashboardQuery>	queries	queries (required).
List<System.String>	colors	Colors define color encoding of data into a visualization (required).
HeatmapViewProperties.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>	generateXAxisTicks	generateXAxisTicks.
System.Nullable<System.Int32>	xTotalTicks	xTotalTicks.
System.Nullable<System.Single>	xTickStart	xTickStart.
System.Nullable<System.Single>	xTickStep	xTickStep.
System.String	yColumn	yColumn (required).
List<System.String>	generateYAxisTicks	generateYAxisTicks.
System.Nullable<System.Int32>	yTotalTicks	yTotalTicks.
System.Nullable<System.Single>	yTickStart	yTickStart.
System.Nullable<System.Single>	yTickStep	yTickStep.
List<System.Nullable<System.Decimal>>	xDomain	xDomain (required).
List<System.Nullable<System.Decimal>>	yDomain	yDomain (required).
System.String	xAxisLabel	xAxisLabel (required).
System.String	yAxisLabel	yAxisLabel (required).
System.String	xPrefix	xPrefix (required).
System.String	xSuffix	xSuffix (required).
System.String	yPrefix	yPrefix (required).
System.String	ySuffix	ySuffix (required).
System.Nullable<System.Decimal>	binSize	binSize (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

BinSize

Gets or Sets BinSize

Declaration

public decimal? BinSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Decimal>

Colors

Colors define color encoding of data into a visualization

Declaration

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

Property Value

Type	Description
List<System.String>	Colors define color encoding of data into a visualization

GenerateXAxisTicks

Gets or Sets GenerateXAxisTicks

Declaration

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

Property Value

Type	Description
List<System.String>

GenerateYAxisTicks

Gets or Sets GenerateYAxisTicks

Declaration

public List<string> GenerateYAxisTicks { 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

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

Property Value

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

TimeFormat

Gets or Sets TimeFormat

Declaration

public string TimeFormat { get; set; }

Property Value

Type	Description
System.String

Type

Gets or Sets Type

Declaration

public HeatmapViewProperties.TypeEnum Type { get; set; }

Property Value

Type	Description
HeatmapViewProperties.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<decimal?> XDomain { get; set; }

Property Value

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

XPrefix

Gets or Sets XPrefix

Declaration

public string XPrefix { get; set; }

Property Value

Type	Description
System.String

XSuffix

Gets or Sets XSuffix

Declaration

public string XSuffix { get; set; }

Property Value

Type	Description
System.String

XTickStart

Gets or Sets XTickStart

Declaration

public float? XTickStart { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

XTickStep

Gets or Sets XTickStep

Declaration

public float? XTickStep { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

XTotalTicks

Gets or Sets XTotalTicks

Declaration

public int? XTotalTicks { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

YAxisLabel

Gets or Sets YAxisLabel

Declaration

public string YAxisLabel { get; set; }

Property Value

Type	Description
System.String

YColumn

Gets or Sets YColumn

Declaration

public string YColumn { get; set; }

Property Value

Type	Description
System.String

YDomain

Gets or Sets YDomain

Declaration

public List<decimal?> YDomain { get; set; }

Property Value

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

YPrefix

Gets or Sets YPrefix

Declaration

public string YPrefix { get; set; }

Property Value

Type	Description
System.String

YSuffix

Gets or Sets YSuffix

Declaration

public string YSuffix { get; set; }

Property Value

Type	Description
System.String

YTickStart

Gets or Sets YTickStart

Declaration

public float? YTickStart { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

YTickStep

Gets or Sets YTickStep

Declaration

public float? YTickStep { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>

YTotalTicks

Gets or Sets YTotalTicks

Declaration

public int? YTotalTicks { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

Equals(HeatmapViewProperties)

Returns true if HeatmapViewProperties instances are equal

Declaration

public bool Equals(HeatmapViewProperties input)

Parameters

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