Class XYViewProperties

XYViewProperties

Inheritance

IEquatable<ViewProperties>

ViewProperties

XYViewProperties

Implements

IEquatable<XYViewProperties>

Inherited Members

ViewProperties.Equals(ViewProperties)

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class XYViewProperties : ViewProperties, IEquatable<XYViewProperties>

Constructors

XYViewProperties()

Initializes a new instance of the XYViewProperties class.

Declaration

protected XYViewProperties()

XYViewProperties(String, XYViewProperties.TypeEnum, List<DashboardQuery>, List<DashboardColor>, Dictionary<String, String>, XYViewProperties.ShapeEnum, String, Nullable<Boolean>, Axes, StaticLegend, String, List<String>, Nullable<Int32>, Nullable<Single>, Nullable<Single>, String, List<String>, Nullable<Int32>, Nullable<Single>, Nullable<Single>, Nullable<Boolean>, Nullable<XYViewProperties.HoverDimensionEnum>, XYViewProperties.PositionEnum, XYGeom, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, Nullable<Int32>)

Initializes a new instance of the XYViewProperties class.

Declaration

public XYViewProperties(string timeFormat = null, XYViewProperties.TypeEnum type = default(XYViewProperties.TypeEnum), List<DashboardQuery> queries = null, List<DashboardColor> colors = null, Dictionary<string, string> colorMapping = null, XYViewProperties.ShapeEnum shape = default(XYViewProperties.ShapeEnum), string note = null, bool? showNoteWhenEmpty = null, Axes axes = null, StaticLegend staticLegend = 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, bool? shadeBelow = null, XYViewProperties.HoverDimensionEnum? hoverDimension = null, XYViewProperties.PositionEnum position = default(XYViewProperties.PositionEnum), XYGeom geom = default(XYGeom), bool? legendColorizeRows = null, bool? legendHide = null, float? legendOpacity = null, int? legendOrientationThreshold = null)

Parameters

Type	Name	Description
System.String	timeFormat	timeFormat.
XYViewProperties.TypeEnum	type	type (required) (default to TypeEnum.Xy).
List<DashboardQuery>	queries	queries (required).
List<DashboardColor>	colors	Colors define color encoding of data into a visualization (required).
Dictionary<System.String, System.String>	colorMapping	A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads..
XYViewProperties.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).
Axes	axes	axes (required).
StaticLegend	staticLegend	staticLegend.
System.String	xColumn	xColumn.
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.
List<System.String>	generateYAxisTicks	generateYAxisTicks.
System.Nullable<System.Int32>	yTotalTicks	yTotalTicks.
System.Nullable<System.Single>	yTickStart	yTickStart.
System.Nullable<System.Single>	yTickStep	yTickStep.
System.Nullable<System.Boolean>	shadeBelow	shadeBelow.
System.Nullable<XYViewProperties.HoverDimensionEnum>	hoverDimension	hoverDimension.
XYViewProperties.PositionEnum	position	position (required).
XYGeom	geom	geom (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

Axes

Gets or Sets Axes

Declaration

public Axes Axes { get; set; }

Property Value

Type	Description
Axes

ColorMapping

A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.

Declaration

public Dictionary<string, string> ColorMapping { get; set; }

Property Value

Type	Description
Dictionary<System.String, System.String>	A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.

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

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>

Geom

Gets or Sets Geom

Declaration

public XYGeom Geom { get; set; }

Property Value

Type	Description
XYGeom

HoverDimension

Gets or Sets HoverDimension

Declaration

public XYViewProperties.HoverDimensionEnum? HoverDimension { get; set; }

Property Value

Type	Description
System.Nullable<XYViewProperties.HoverDimensionEnum>

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 XYViewProperties.PositionEnum Position { get; set; }

Property Value

Type	Description
XYViewProperties.PositionEnum

Queries

Gets or Sets Queries

Declaration

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

Property Value

Type	Description
List<DashboardQuery>

ShadeBelow

Gets or Sets ShadeBelow

Declaration

public bool? ShadeBelow { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Shape

Gets or Sets Shape

Declaration

public XYViewProperties.ShapeEnum Shape { get; set; }

Property Value

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

TimeFormat

Gets or Sets TimeFormat

Declaration

public string TimeFormat { get; set; }

Property Value

Type	Description
System.String

Type

Gets or Sets Type

Declaration

public XYViewProperties.TypeEnum Type { get; set; }

Property Value

Type	Description
XYViewProperties.TypeEnum

XColumn

Gets or Sets XColumn

Declaration

public string XColumn { 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>

YColumn

Gets or Sets YColumn

Declaration

public string YColumn { 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(XYViewProperties)

Returns true if XYViewProperties instances are equal

Declaration

public bool Equals(XYViewProperties input)

Parameters

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