Package com.influxdb.client.domain

Class XYViewProperties

java.lang.Object

com.influxdb.client.domain.ViewProperties

com.influxdb.client.domain.XYViewProperties

public class XYViewProperties
extends ViewProperties

XYViewProperties

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_AXES
static final String	SERIALIZED_NAME_COLOR_MAPPING
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_NOTE
static final String	SERIALIZED_NAME_POSITION
static final String	SERIALIZED_NAME_QUERIES
static final String	SERIALIZED_NAME_SHADE_BELOW
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_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
XYViewProperties()

Method Summary

Modifier and Type	Method	Description
XYViewProperties	addColorsItem(DashboardColor colorsItem)
XYViewProperties	addGenerateXAxisTicksItem(String generateXAxisTicksItem)
XYViewProperties	addGenerateYAxisTicksItem(String generateYAxisTicksItem)
XYViewProperties	addQueriesItem(DashboardQuery queriesItem)
XYViewProperties	axes(Axes axes)
XYViewProperties	colorMapping(Map<String,String> colorMapping)
XYViewProperties	colors(List<DashboardColor> colors)
boolean	equals(Object o)
XYViewProperties	generateXAxisTicks(List<String> generateXAxisTicks)
XYViewProperties	generateYAxisTicks(List<String> generateYAxisTicks)
XYViewProperties	geom(XYGeom geom)
Axes	getAxes()	Get axes
Map<String,String>	getColorMapping()	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.
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
XYViewProperties.HoverDimensionEnum	getHoverDimension()	Get hoverDimension
Boolean	getLegendColorizeRows()	Get legendColorizeRows
Boolean	getLegendHide()	Get legendHide
Float	getLegendOpacity()	Get legendOpacity
Integer	getLegendOrientationThreshold()	Get legendOrientationThreshold
String	getNote()	Get note
XYViewProperties.PositionEnum	getPosition()	Get position
List<DashboardQuery>	getQueries()	Get queries
Boolean	getShadeBelow()	Get shadeBelow
XYViewProperties.ShapeEnum	getShape()	Get shape
Boolean	getShowNoteWhenEmpty()	If true, will display note when empty
StaticLegend	getStaticLegend()	Get staticLegend
String	getTimeFormat()	Get timeFormat
XYViewProperties.TypeEnum	getType()	Get type
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()
XYViewProperties	hoverDimension(XYViewProperties.HoverDimensionEnum hoverDimension)
XYViewProperties	legendColorizeRows(Boolean legendColorizeRows)
XYViewProperties	legendHide(Boolean legendHide)
XYViewProperties	legendOpacity(Float legendOpacity)
XYViewProperties	legendOrientationThreshold(Integer legendOrientationThreshold)
XYViewProperties	note(String note)
XYViewProperties	position(XYViewProperties.PositionEnum position)
XYViewProperties	putColorMappingItem(String key, String colorMappingItem)
XYViewProperties	queries(List<DashboardQuery> queries)
void	setAxes(Axes axes)
void	setColorMapping(Map<String,String> colorMapping)
void	setColors(List<DashboardColor> colors)
void	setGenerateXAxisTicks(List<String> generateXAxisTicks)
void	setGenerateYAxisTicks(List<String> generateYAxisTicks)
void	setGeom(XYGeom geom)
void	setHoverDimension(XYViewProperties.HoverDimensionEnum hoverDimension)
void	setLegendColorizeRows(Boolean legendColorizeRows)
void	setLegendHide(Boolean legendHide)
void	setLegendOpacity(Float legendOpacity)
void	setLegendOrientationThreshold(Integer legendOrientationThreshold)
void	setNote(String note)
void	setPosition(XYViewProperties.PositionEnum position)
void	setQueries(List<DashboardQuery> queries)
void	setShadeBelow(Boolean shadeBelow)
void	setShowNoteWhenEmpty(Boolean showNoteWhenEmpty)
void	setStaticLegend(StaticLegend staticLegend)
void	setTimeFormat(String timeFormat)
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)
XYViewProperties	shadeBelow(Boolean shadeBelow)
XYViewProperties	showNoteWhenEmpty(Boolean showNoteWhenEmpty)
XYViewProperties	staticLegend(StaticLegend staticLegend)
XYViewProperties	timeFormat(String timeFormat)
String	toString()
XYViewProperties	xColumn(String xColumn)
XYViewProperties	xTickStart(Float xTickStart)
XYViewProperties	xTickStep(Float xTickStep)
XYViewProperties	xTotalTicks(Integer xTotalTicks)
XYViewProperties	yColumn(String yColumn)
XYViewProperties	yTickStart(Float yTickStart)
XYViewProperties	yTickStep(Float yTickStep)
XYViewProperties	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_COLOR_MAPPING

public static final String SERIALIZED_NAME_COLOR_MAPPING

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_SHADE_BELOW

public static final String SERIALIZED_NAME_SHADE_BELOW

See Also:

• Constant Field Values

SERIALIZED_NAME_HOVER_DIMENSION

public static final String SERIALIZED_NAME_HOVER_DIMENSION

See Also:

• Constant Field Values

SERIALIZED_NAME_POSITION

public static final String SERIALIZED_NAME_POSITION

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

XYViewProperties

public XYViewProperties()

Method Details

timeFormat

public XYViewProperties timeFormat(String timeFormat)

getTimeFormat

public String getTimeFormat()

Get timeFormat

Returns:

timeFormat

setTimeFormat

public void setTimeFormat(String timeFormat)

getType

public XYViewProperties.TypeEnum getType()

Get type

Returns:

type

queries

public XYViewProperties queries(List<DashboardQuery> queries)

addQueriesItem

public XYViewProperties addQueriesItem(DashboardQuery queriesItem)

getQueries

public List<DashboardQuery> getQueries()

Get queries

Returns:

queries

setQueries

public void setQueries(List<DashboardQuery> queries)

colors

public XYViewProperties colors(List<DashboardColor> colors)

addColorsItem

public XYViewProperties 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)

colorMapping

public XYViewProperties colorMapping(Map<String,String> colorMapping)

putColorMappingItem

public XYViewProperties putColorMappingItem(String key,
 String colorMappingItem)

getColorMapping

public Map<String,String> getColorMapping()

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.

Returns:

colorMapping

setColorMapping

public void setColorMapping(Map<String,String> colorMapping)

getShape

public XYViewProperties.ShapeEnum getShape()

Get shape

Returns:

shape

note

public XYViewProperties note(String note)

getNote

public String getNote()

Get note

Returns:

note

setNote

public void setNote(String note)

showNoteWhenEmpty

public XYViewProperties showNoteWhenEmpty(Boolean showNoteWhenEmpty)

getShowNoteWhenEmpty

public Boolean getShowNoteWhenEmpty()

If true, will display note when empty

Returns:

showNoteWhenEmpty

setShowNoteWhenEmpty

public void setShowNoteWhenEmpty(Boolean showNoteWhenEmpty)

axes

public XYViewProperties axes(Axes axes)

getAxes

public Axes getAxes()

Get axes

Returns:

axes

setAxes

public void setAxes(Axes axes)

staticLegend

public XYViewProperties staticLegend(StaticLegend staticLegend)

getStaticLegend

public StaticLegend getStaticLegend()

Get staticLegend

Returns:

staticLegend

setStaticLegend

public void setStaticLegend(StaticLegend staticLegend)

xColumn

public XYViewProperties xColumn(String xColumn)

getXColumn

public String getXColumn()

Get xColumn

Returns:

xColumn

setXColumn

public void setXColumn(String xColumn)

generateXAxisTicks

public XYViewProperties generateXAxisTicks(List<String> generateXAxisTicks)

addGenerateXAxisTicksItem

public XYViewProperties addGenerateXAxisTicksItem(String generateXAxisTicksItem)

getGenerateXAxisTicks

public List<String> getGenerateXAxisTicks()

Get generateXAxisTicks

Returns:

generateXAxisTicks

setGenerateXAxisTicks

public void setGenerateXAxisTicks(List<String> generateXAxisTicks)

xTotalTicks

public XYViewProperties xTotalTicks(Integer xTotalTicks)

getXTotalTicks

public Integer getXTotalTicks()

Get xTotalTicks

Returns:

xTotalTicks

setXTotalTicks

public void setXTotalTicks(Integer xTotalTicks)

xTickStart

public XYViewProperties xTickStart(Float xTickStart)

getXTickStart

public Float getXTickStart()

Get xTickStart

Returns:

xTickStart

setXTickStart

public void setXTickStart(Float xTickStart)

xTickStep

public XYViewProperties xTickStep(Float xTickStep)

getXTickStep

public Float getXTickStep()

Get xTickStep

Returns:

xTickStep

setXTickStep

public void setXTickStep(Float xTickStep)

yColumn

public XYViewProperties yColumn(String yColumn)

getYColumn

public String getYColumn()

Get yColumn

Returns:

yColumn

setYColumn

public void setYColumn(String yColumn)

generateYAxisTicks

public XYViewProperties generateYAxisTicks(List<String> generateYAxisTicks)

addGenerateYAxisTicksItem

public XYViewProperties addGenerateYAxisTicksItem(String generateYAxisTicksItem)

getGenerateYAxisTicks

public List<String> getGenerateYAxisTicks()

Get generateYAxisTicks

Returns:

generateYAxisTicks

setGenerateYAxisTicks

public void setGenerateYAxisTicks(List<String> generateYAxisTicks)

yTotalTicks

public XYViewProperties yTotalTicks(Integer yTotalTicks)

getYTotalTicks

public Integer getYTotalTicks()

Get yTotalTicks

Returns:

yTotalTicks

setYTotalTicks

public void setYTotalTicks(Integer yTotalTicks)

yTickStart

public XYViewProperties yTickStart(Float yTickStart)

getYTickStart

public Float getYTickStart()

Get yTickStart

Returns:

yTickStart

setYTickStart

public void setYTickStart(Float yTickStart)

yTickStep

public XYViewProperties yTickStep(Float yTickStep)

getYTickStep

public Float getYTickStep()

Get yTickStep

Returns:

yTickStep

setYTickStep

public void setYTickStep(Float yTickStep)

shadeBelow

public XYViewProperties shadeBelow(Boolean shadeBelow)

getShadeBelow

public Boolean getShadeBelow()

Get shadeBelow

Returns:

shadeBelow

setShadeBelow

public void setShadeBelow(Boolean shadeBelow)

hoverDimension

public XYViewProperties hoverDimension(XYViewProperties.HoverDimensionEnum hoverDimension)

getHoverDimension

public XYViewProperties.HoverDimensionEnum getHoverDimension()

Get hoverDimension

Returns:

hoverDimension

setHoverDimension

public void setHoverDimension(XYViewProperties.HoverDimensionEnum hoverDimension)

position

public XYViewProperties position(XYViewProperties.PositionEnum position)

getPosition

public XYViewProperties.PositionEnum getPosition()

Get position

Returns:

position

setPosition

public void setPosition(XYViewProperties.PositionEnum position)

geom

public XYViewProperties geom(XYGeom geom)

getGeom

public XYGeom getGeom()

Get geom

Returns:

geom

setGeom

public void setGeom(XYGeom geom)

legendColorizeRows

public XYViewProperties legendColorizeRows(Boolean legendColorizeRows)

getLegendColorizeRows

public Boolean getLegendColorizeRows()

Get legendColorizeRows

Returns:

legendColorizeRows

setLegendColorizeRows

public void setLegendColorizeRows(Boolean legendColorizeRows)

legendHide

public XYViewProperties legendHide(Boolean legendHide)

getLegendHide

public Boolean getLegendHide()

Get legendHide

Returns:

legendHide

setLegendHide

public void setLegendHide(Boolean legendHide)

legendOpacity

public XYViewProperties legendOpacity(Float legendOpacity)

getLegendOpacity

public Float getLegendOpacity()

Get legendOpacity

Returns:

legendOpacity

setLegendOpacity

public void setLegendOpacity(Float legendOpacity)

legendOrientationThreshold

public XYViewProperties 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