Class TableViewProperties
TableViewProperties
Implements
Inherited Members
Namespace: InfluxDB.Client.Api.Domain
Assembly: InfluxDB.Client.dll
Syntax
public class TableViewProperties : ViewProperties, IEquatable<TableViewProperties>
Constructors
TableViewProperties()
Initializes a new instance of the TableViewProperties class.
Declaration
protected TableViewProperties()
TableViewProperties(TableViewProperties.TypeEnum, List<DashboardQuery>, List<DashboardColor>, TableViewProperties.ShapeEnum, String, Nullable<Boolean>, TableViewPropertiesTableOptions, List<RenamableField>, String, DecimalPlaces)
Initializes a new instance of the TableViewProperties class.
Declaration
public TableViewProperties(TableViewProperties.TypeEnum type = default(TableViewProperties.TypeEnum), List<DashboardQuery> queries = null, List<DashboardColor> colors = null, TableViewProperties.ShapeEnum shape = default(TableViewProperties.ShapeEnum), string note = null, bool? showNoteWhenEmpty = null, TableViewPropertiesTableOptions tableOptions = null, List<RenamableField> fieldOptions = null, string timeFormat = null, DecimalPlaces decimalPlaces = null)
Parameters
Type | Name | Description |
---|---|---|
TableViewProperties.TypeEnum | type | type (required) (default to TypeEnum.Table). |
List<DashboardQuery> | queries | queries (required). |
List<DashboardColor> | colors | Colors define color encoding of data into a visualization (required). |
TableViewProperties.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). |
TableViewPropertiesTableOptions | tableOptions | tableOptions (required). |
List<RenamableField> | fieldOptions | fieldOptions represent the fields retrieved by the query with customization options (required). |
System.String | timeFormat | timeFormat describes the display format for time values according to moment.js date formatting (required). |
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 |
FieldOptions
fieldOptions represent the fields retrieved by the query with customization options
Declaration
public List<RenamableField> FieldOptions { get; set; }
Property Value
Type | Description |
---|---|
List<RenamableField> | fieldOptions represent the fields retrieved by the query with customization options |
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 TableViewProperties.ShapeEnum Shape { get; set; }
Property Value
Type | Description |
---|---|
TableViewProperties.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 |
TableOptions
Gets or Sets TableOptions
Declaration
public TableViewPropertiesTableOptions TableOptions { get; set; }
Property Value
Type | Description |
---|---|
TableViewPropertiesTableOptions |
TimeFormat
timeFormat describes the display format for time values according to moment.js date formatting
Declaration
public string TimeFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | timeFormat describes the display format for time values according to moment.js date formatting |
Type
Gets or Sets Type
Declaration
public TableViewProperties.TypeEnum Type { get; set; }
Property Value
Type | Description |
---|---|
TableViewProperties.TypeEnum |
Methods
Equals(TableViewProperties)
Returns true if TableViewProperties instances are equal
Declaration
public bool Equals(TableViewProperties input)
Parameters
Type | Name | Description |
---|---|---|
TableViewProperties | input | Instance of TableViewProperties 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
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Hash code |
Overrides
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
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String presentation of the object |