Package com.influxdb.client.domain

Class BandViewProperties

java.lang.Object

com.influxdb.client.domain.ViewProperties

com.influxdb.client.domain.BandViewProperties

public class BandViewProperties
extends ViewProperties

BandViewProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BandViewProperties.HoverDimensionEnum	Gets or Sets hoverDimension
static enum	BandViewProperties.ShapeEnum	Gets or Sets shape
static enum	BandViewProperties.TypeEnum	Gets or Sets type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_AXES
static final String	SERIALIZED_NAME_COLORS
static final String	SERIALIZED_NAME_GENERATE_X_AXIS_TICKS
static final String	SERIALIZED_NAME_GENERATE_Y_AXIS_TICKS
static final String	SERIALIZED_NAME_GEOM
static final String	SERIALIZED_NAME_HOVER_DIMENSION
static final String	SERIALIZED_NAME_LEGEND_COLORIZE_ROWS
static final String	SERIALIZED_NAME_LEGEND_HIDE
static final String	SERIALIZED_NAME_LEGEND_OPACITY
static final String	SERIALIZED_NAME_LEGEND_ORIENTATION_THRESHOLD
static final String	SERIALIZED_NAME_LOWER_COLUMN
static final String	SERIALIZED_NAME_MAIN_COLUMN
static final String	SERIALIZED_NAME_NOTE
static final String	SERIALIZED_NAME_QUERIES
static final String	SERIALIZED_NAME_SHAPE
static final String	SERIALIZED_NAME_SHOW_NOTE_WHEN_EMPTY
static final String	SERIALIZED_NAME_STATIC_LEGEND
static final String	SERIALIZED_NAME_TIME_FORMAT
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UPPER_COLUMN
static final String	SERIALIZED_NAME_X_COLUMN
static final String	SERIALIZED_NAME_X_TICK_START
static final String	SERIALIZED_NAME_X_TICK_STEP
static final String	SERIALIZED_NAME_X_TOTAL_TICKS
static final String	SERIALIZED_NAME_Y_COLUMN
static final String	SERIALIZED_NAME_Y_TICK_START
static final String	SERIALIZED_NAME_Y_TICK_STEP
static final String	SERIALIZED_NAME_Y_TOTAL_TICKS

Constructor Summary

Constructors

Constructor	Description
BandViewProperties()

Method Summary

Modifier and Type	Method	Description
BandViewProperties	addColorsItem(DashboardColor colorsItem)
BandViewProperties	addGenerateXAxisTicksItem(String generateXAxisTicksItem)
BandViewProperties	addGenerateYAxisTicksItem(String generateYAxisTicksItem)
BandViewProperties	addQueriesItem(DashboardQuery queriesItem)
BandViewProperties	axes(Axes axes)
BandViewProperties	colors(List<DashboardColor> colors)
boolean	equals(Object o)
BandViewProperties	generateXAxisTicks(List<String> generateXAxisTicks)
BandViewProperties	generateYAxisTicks(List<String> generateYAxisTicks)
BandViewProperties	geom(XYGeom geom)
Axes	getAxes()	Get axes
List<DashboardColor>	getColors()	Colors define color encoding of data into a visualization
List<String>	getGenerateXAxisTicks()	Get generateXAxisTicks
List<String>	getGenerateYAxisTicks()	Get generateYAxisTicks
XYGeom	getGeom()	Get geom
BandViewProperties.HoverDimensionEnum	getHoverDimension()	Get hoverDimension
Boolean	getLegendColorizeRows()	Get legendColorizeRows
Boolean	getLegendHide()	Get legendHide
Float	getLegendOpacity()	Get legendOpacity
Integer	getLegendOrientationThreshold()	Get legendOrientationThreshold
String	getLowerColumn()	Get lowerColumn
String	getMainColumn()	Get mainColumn
String	getNote()	Get note
List<DashboardQuery>	getQueries()	Get queries
BandViewProperties.ShapeEnum	getShape()	Get shape
Boolean	getShowNoteWhenEmpty()	If true, will display note when empty
StaticLegend	getStaticLegend()	Get staticLegend
String	getTimeFormat()	Get timeFormat
BandViewProperties.TypeEnum	getType()	Get type
String	getUpperColumn()	Get upperColumn
String	getXColumn()	Get xColumn
Float	getXTickStart()	Get xTickStart
Float	getXTickStep()	Get xTickStep
Integer	getXTotalTicks()	Get xTotalTicks
String	getYColumn()	Get yColumn
Float	getYTickStart()	Get yTickStart
Float	getYTickStep()	Get yTickStep
Integer	getYTotalTicks()	Get yTotalTicks
int	hashCode()
BandViewProperties	hoverDimension(BandViewProperties.HoverDimensionEnum hoverDimension)
BandViewProperties	legendColorizeRows(Boolean legendColorizeRows)
BandViewProperties	legendHide(Boolean legendHide)
BandViewProperties	legendOpacity(Float legendOpacity)
BandViewProperties	legendOrientationThreshold(Integer legendOrientationThreshold)
BandViewProperties	lowerColumn(String lowerColumn)
BandViewProperties	mainColumn(String mainColumn)
BandViewProperties	note(String note)
BandViewProperties	queries(List<DashboardQuery> queries)
void	setAxes(Axes axes)
void	setColors(List<DashboardColor> colors)
void	setGenerateXAxisTicks(List<String> generateXAxisTicks)
void	setGenerateYAxisTicks(List<String> generateYAxisTicks)
void	setGeom(XYGeom geom)
void	setHoverDimension(BandViewProperties.HoverDimensionEnum hoverDimension)
void	setLegendColorizeRows(Boolean legendColorizeRows)
void	setLegendHide(Boolean legendHide)
void	setLegendOpacity(Float legendOpacity)
void	setLegendOrientationThreshold(Integer legendOrientationThreshold)
void	setLowerColumn(String lowerColumn)
void	setMainColumn(String mainColumn)
void	setNote(String note)
void	setQueries(List<DashboardQuery> queries)
void	setShowNoteWhenEmpty(Boolean showNoteWhenEmpty)
void	setStaticLegend(StaticLegend staticLegend)
void	setTimeFormat(String timeFormat)
void	setUpperColumn(String upperColumn)
void	setXColumn(String xColumn)
void	setXTickStart(Float xTickStart)
void	setXTickStep(Float xTickStep)
void	setXTotalTicks(Integer xTotalTicks)
void	setYColumn(String yColumn)
void	setYTickStart(Float yTickStart)
void	setYTickStep(Float yTickStep)
void	setYTotalTicks(Integer yTotalTicks)
BandViewProperties	showNoteWhenEmpty(Boolean showNoteWhenEmpty)
BandViewProperties	staticLegend(StaticLegend staticLegend)
BandViewProperties	timeFormat(String timeFormat)
String	toString()
BandViewProperties	upperColumn(String upperColumn)
BandViewProperties	xColumn(String xColumn)
BandViewProperties	xTickStart(Float xTickStart)
BandViewProperties	xTickStep(Float xTickStep)
BandViewProperties	xTotalTicks(Integer xTotalTicks)
BandViewProperties	yColumn(String yColumn)
BandViewProperties	yTickStart(Float yTickStart)
BandViewProperties	yTickStep(Float yTickStep)
BandViewProperties	yTotalTicks(Integer yTotalTicks)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_TIME_FORMAT

public static final String SERIALIZED_NAME_TIME_FORMAT

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_QUERIES

public static final String SERIALIZED_NAME_QUERIES

See Also:

• Constant Field Values

SERIALIZED_NAME_COLORS

public static final String SERIALIZED_NAME_COLORS

See Also:

• Constant Field Values

SERIALIZED_NAME_SHAPE

public static final String SERIALIZED_NAME_SHAPE

See Also:

• Constant Field Values

SERIALIZED_NAME_NOTE

public static final String SERIALIZED_NAME_NOTE

See Also:

• Constant Field Values

SERIALIZED_NAME_SHOW_NOTE_WHEN_EMPTY

public static final String SERIALIZED_NAME_SHOW_NOTE_WHEN_EMPTY

See Also:

• Constant Field Values

SERIALIZED_NAME_AXES

public static final String SERIALIZED_NAME_AXES

See Also:

• Constant Field Values

SERIALIZED_NAME_STATIC_LEGEND

public static final String SERIALIZED_NAME_STATIC_LEGEND

See Also:

• Constant Field Values

SERIALIZED_NAME_X_COLUMN

public static final String SERIALIZED_NAME_X_COLUMN

See Also:

• Constant Field Values

SERIALIZED_NAME_GENERATE_X_AXIS_TICKS

public static final String SERIALIZED_NAME_GENERATE_X_AXIS_TICKS

See Also:

• Constant Field Values

SERIALIZED_NAME_X_TOTAL_TICKS

public static final String SERIALIZED_NAME_X_TOTAL_TICKS

See Also:

• Constant Field Values

SERIALIZED_NAME_X_TICK_START

public static final String SERIALIZED_NAME_X_TICK_START

See Also:

• Constant Field Values

SERIALIZED_NAME_X_TICK_STEP

public static final String SERIALIZED_NAME_X_TICK_STEP

See Also:

• Constant Field Values

SERIALIZED_NAME_Y_COLUMN

public static final String SERIALIZED_NAME_Y_COLUMN

See Also:

• Constant Field Values

SERIALIZED_NAME_GENERATE_Y_AXIS_TICKS

public static final String SERIALIZED_NAME_GENERATE_Y_AXIS_TICKS

See Also:

• Constant Field Values

SERIALIZED_NAME_Y_TOTAL_TICKS

public static final String SERIALIZED_NAME_Y_TOTAL_TICKS

See Also:

• Constant Field Values

SERIALIZED_NAME_Y_TICK_START

public static final String SERIALIZED_NAME_Y_TICK_START

See Also:

• Constant Field Values

SERIALIZED_NAME_Y_TICK_STEP

public static final String SERIALIZED_NAME_Y_TICK_STEP

See Also:

• Constant Field Values

SERIALIZED_NAME_UPPER_COLUMN

public static final String SERIALIZED_NAME_UPPER_COLUMN

See Also:

• Constant Field Values

SERIALIZED_NAME_MAIN_COLUMN

public static final String SERIALIZED_NAME_MAIN_COLUMN

See Also:

• Constant Field Values

SERIALIZED_NAME_LOWER_COLUMN

public static final String SERIALIZED_NAME_LOWER_COLUMN

See Also:

• Constant Field Values

SERIALIZED_NAME_HOVER_DIMENSION

public static final String SERIALIZED_NAME_HOVER_DIMENSION

See Also:

• Constant Field Values

SERIALIZED_NAME_GEOM

public static final String SERIALIZED_NAME_GEOM

See Also:

• Constant Field Values

SERIALIZED_NAME_LEGEND_COLORIZE_ROWS

public static final String SERIALIZED_NAME_LEGEND_COLORIZE_ROWS

See Also:

• Constant Field Values

SERIALIZED_NAME_LEGEND_HIDE

public static final String SERIALIZED_NAME_LEGEND_HIDE

See Also:

• Constant Field Values

SERIALIZED_NAME_LEGEND_OPACITY

public static final String SERIALIZED_NAME_LEGEND_OPACITY

See Also:

• Constant Field Values

SERIALIZED_NAME_LEGEND_ORIENTATION_THRESHOLD

public static final String SERIALIZED_NAME_LEGEND_ORIENTATION_THRESHOLD

See Also:

• Constant Field Values

Constructor Details

BandViewProperties

public BandViewProperties()

Method Details

timeFormat

public BandViewProperties timeFormat(String timeFormat)

getTimeFormat

public String getTimeFormat()

Get timeFormat

Returns:

timeFormat

setTimeFormat

public void setTimeFormat(String timeFormat)

getType

public BandViewProperties.TypeEnum getType()

Get type

Returns:

type

queries

public BandViewProperties queries(List<DashboardQuery> queries)

addQueriesItem

public BandViewProperties addQueriesItem(DashboardQuery queriesItem)

getQueries

public List<DashboardQuery> getQueries()

Get queries

Returns:

queries

setQueries

public void setQueries(List<DashboardQuery> queries)

colors

public BandViewProperties colors(List<DashboardColor> colors)

addColorsItem

public BandViewProperties addColorsItem(DashboardColor colorsItem)

getColors

public List<DashboardColor> getColors()

Colors define color encoding of data into a visualization

Returns:

colors

setColors

public void setColors(List<DashboardColor> colors)

getShape

public BandViewProperties.ShapeEnum getShape()

Get shape

Returns:

shape

note

public BandViewProperties note(String note)

getNote

public String getNote()

Get note

Returns:

note

setNote

public void setNote(String note)

showNoteWhenEmpty

public BandViewProperties showNoteWhenEmpty(Boolean showNoteWhenEmpty)

getShowNoteWhenEmpty

public Boolean getShowNoteWhenEmpty()

If true, will display note when empty

Returns:

showNoteWhenEmpty

setShowNoteWhenEmpty

public void setShowNoteWhenEmpty(Boolean showNoteWhenEmpty)

axes

public BandViewProperties axes(Axes axes)

getAxes

public Axes getAxes()

Get axes

Returns:

axes

setAxes

public void setAxes(Axes axes)

staticLegend

public BandViewProperties staticLegend(StaticLegend staticLegend)

getStaticLegend

public StaticLegend getStaticLegend()

Get staticLegend

Returns:

staticLegend

setStaticLegend

public void setStaticLegend(StaticLegend staticLegend)

xColumn

public BandViewProperties xColumn(String xColumn)

getXColumn

public String getXColumn()

Get xColumn

Returns:

xColumn

setXColumn

public void setXColumn(String xColumn)

generateXAxisTicks

public BandViewProperties generateXAxisTicks(List<String> generateXAxisTicks)

addGenerateXAxisTicksItem

public BandViewProperties addGenerateXAxisTicksItem(String generateXAxisTicksItem)

getGenerateXAxisTicks

public List<String> getGenerateXAxisTicks()

Get generateXAxisTicks

Returns:

generateXAxisTicks

setGenerateXAxisTicks

public void setGenerateXAxisTicks(List<String> generateXAxisTicks)

xTotalTicks

public BandViewProperties xTotalTicks(Integer xTotalTicks)

getXTotalTicks

public Integer getXTotalTicks()

Get xTotalTicks

Returns:

xTotalTicks

setXTotalTicks

public void setXTotalTicks(Integer xTotalTicks)

xTickStart

public BandViewProperties xTickStart(Float xTickStart)

getXTickStart

public Float getXTickStart()

Get xTickStart

Returns:

xTickStart

setXTickStart

public void setXTickStart(Float xTickStart)

xTickStep

public BandViewProperties xTickStep(Float xTickStep)

getXTickStep

public Float getXTickStep()

Get xTickStep

Returns:

xTickStep

setXTickStep

public void setXTickStep(Float xTickStep)

yColumn

public BandViewProperties yColumn(String yColumn)

getYColumn

public String getYColumn()

Get yColumn

Returns:

yColumn

setYColumn

public void setYColumn(String yColumn)

generateYAxisTicks

public BandViewProperties generateYAxisTicks(List<String> generateYAxisTicks)

addGenerateYAxisTicksItem

public BandViewProperties addGenerateYAxisTicksItem(String generateYAxisTicksItem)

getGenerateYAxisTicks

public List<String> getGenerateYAxisTicks()

Get generateYAxisTicks

Returns:

generateYAxisTicks

setGenerateYAxisTicks

public void setGenerateYAxisTicks(List<String> generateYAxisTicks)

yTotalTicks

public BandViewProperties yTotalTicks(Integer yTotalTicks)

getYTotalTicks

public Integer getYTotalTicks()

Get yTotalTicks

Returns:

yTotalTicks

setYTotalTicks

public void setYTotalTicks(Integer yTotalTicks)

yTickStart

public BandViewProperties yTickStart(Float yTickStart)

getYTickStart

public Float getYTickStart()

Get yTickStart

Returns:

yTickStart

setYTickStart

public void setYTickStart(Float yTickStart)

yTickStep

public BandViewProperties yTickStep(Float yTickStep)

getYTickStep

public Float getYTickStep()

Get yTickStep

Returns:

yTickStep

setYTickStep

public void setYTickStep(Float yTickStep)

upperColumn

public BandViewProperties upperColumn(String upperColumn)

getUpperColumn

public String getUpperColumn()

Get upperColumn

Returns:

upperColumn

setUpperColumn

public void setUpperColumn(String upperColumn)

mainColumn

public BandViewProperties mainColumn(String mainColumn)

getMainColumn

public String getMainColumn()

Get mainColumn

Returns:

mainColumn

setMainColumn

public void setMainColumn(String mainColumn)

lowerColumn

public BandViewProperties lowerColumn(String lowerColumn)

getLowerColumn

public String getLowerColumn()

Get lowerColumn

Returns:

lowerColumn

setLowerColumn

public void setLowerColumn(String lowerColumn)

hoverDimension

public BandViewProperties hoverDimension(BandViewProperties.HoverDimensionEnum hoverDimension)

getHoverDimension

public BandViewProperties.HoverDimensionEnum getHoverDimension()

Get hoverDimension

Returns:

hoverDimension

setHoverDimension

public void setHoverDimension(BandViewProperties.HoverDimensionEnum hoverDimension)

geom

public BandViewProperties geom(XYGeom geom)

getGeom

public XYGeom getGeom()

Get geom

Returns:

geom

setGeom

public void setGeom(XYGeom geom)

legendColorizeRows

public BandViewProperties legendColorizeRows(Boolean legendColorizeRows)

getLegendColorizeRows

public Boolean getLegendColorizeRows()

Get legendColorizeRows

Returns:

legendColorizeRows

setLegendColorizeRows

public void setLegendColorizeRows(Boolean legendColorizeRows)

legendHide

public BandViewProperties legendHide(Boolean legendHide)

getLegendHide

public Boolean getLegendHide()

Get legendHide

Returns:

legendHide

setLegendHide

public void setLegendHide(Boolean legendHide)

legendOpacity

public BandViewProperties legendOpacity(Float legendOpacity)

getLegendOpacity

public Float getLegendOpacity()

Get legendOpacity

Returns:

legendOpacity

setLegendOpacity

public void setLegendOpacity(Float legendOpacity)

legendOrientationThreshold

public BandViewProperties legendOrientationThreshold(Integer legendOrientationThreshold)

getLegendOrientationThreshold

public Integer getLegendOrientationThreshold()

Get legendOrientationThreshold

Returns:

legendOrientationThreshold

setLegendOrientationThreshold

public void setLegendOrientationThreshold(Integer legendOrientationThreshold)

equals

public boolean equals(Object o)

Overrides:

equals in class ViewProperties

hashCode

public int hashCode()

Overrides:

hashCode in class ViewProperties

toString

public String toString()

Overrides:

toString in class ViewProperties