Inheritance diagram for InfluxDB2\Model\XYViewProperties:

Public Member Functions
	getModelName ()

	getTypeAllowableValues ()

	getShapeAllowableValues ()

	getHoverDimensionAllowableValues ()

	getPositionAllowableValues ()

	__construct (array $data=null)

	listInvalidProperties ()

	valid ()

	getAdaptiveZoomHide ()

	setAdaptiveZoomHide ($adaptive_zoom_hide)

	getTimeFormat ()

	setTimeFormat ($time_format)

	getType ()

	setType ($type)

	getQueries ()

	setQueries ($queries)

	getColors ()

	setColors ($colors)

	getColorMapping ()

	setColorMapping ($color_mapping)

	getShape ()

	setShape ($shape)

	getNote ()

	setNote ($note)

	getShowNoteWhenEmpty ()

	setShowNoteWhenEmpty ($show_note_when_empty)

	getAxes ()

	setAxes ($axes)

	getStaticLegend ()

	setStaticLegend ($static_legend)

	getXColumn ()

	setXColumn ($x_column)

	getGenerateXAxisTicks ()

	setGenerateXAxisTicks ($generate_x_axis_ticks)

	getXTotalTicks ()

	setXTotalTicks ($x_total_ticks)

	getXTickStart ()

	setXTickStart ($x_tick_start)

	getXTickStep ()

	setXTickStep ($x_tick_step)

	getYColumn ()

	setYColumn ($y_column)

	getGenerateYAxisTicks ()

	setGenerateYAxisTicks ($generate_y_axis_ticks)

	getYTotalTicks ()

	setYTotalTicks ($y_total_ticks)

	getYTickStart ()

	setYTickStart ($y_tick_start)

	getYTickStep ()

	setYTickStep ($y_tick_step)

	getShadeBelow ()

	setShadeBelow ($shade_below)

	getHoverDimension ()

	setHoverDimension ($hover_dimension)

	getPosition ()

	setPosition ($position)

	getGeom ()

	setGeom ($geom)

	getLegendColorizeRows ()

	setLegendColorizeRows ($legend_colorize_rows)

	getLegendHide ()

	setLegendHide ($legend_hide)

	getLegendOpacity ()

	setLegendOpacity ($legend_opacity)

	getLegendOrientationThreshold ()

	setLegendOrientationThreshold ($legend_orientation_threshold)

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	__toString ()

Static Public Member Functions
static	openAPITypes ()

static	openAPIFormats ()

static	attributeMap ()

static	setters ()

static	getters ()

Public Attributes
const	DISCRIMINATOR = null

const	TYPE_XY = 'xy'

const	SHAPE_CHRONOGRAF_V2 = 'chronograf-v2'

const	HOVER_DIMENSION_AUTO = 'auto'

const	HOVER_DIMENSION_X = 'x'

const	HOVER_DIMENSION_Y = 'y'

const	HOVER_DIMENSION_XY = 'xy'

const	POSITION_OVERLAID = 'overlaid'

const	POSITION_STACKED = 'stacked'

Public Attributes inherited from InfluxDB2\Model\ViewProperties
const	DISCRIMINATOR = null

Static Protected Attributes
static	$openAPIModelName = 'XYViewProperties'

static	$openAPITypes

static	$openAPIFormats

static	$attributeMap

static	$setters

static	$getters

Static Protected Attributes inherited from InfluxDB2\Model\ViewProperties
static	$openAPIModelName = 'ViewProperties'

static	$openAPITypes

static	$openAPIFormats

static	$attributeMap

static	$setters

static	$getters

Additional Inherited Members
Protected Attributes inherited from InfluxDB2\Model\ViewProperties
	$container = []

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Model\XYViewProperties::__construct ( array $data = null )

Constructor

Parameters

mixed[] $data Associated array of property values initializing the model

Reimplemented from InfluxDB2\Model\ViewProperties.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\XYViewProperties::__toString ( )

Gets the string presentation of the object

Returns: string

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ attributeMap()

static InfluxDB2\Model\XYViewProperties::attributeMap ( )

static

Array of attributes where the key is the local name, and the value is the original name

Returns: array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getAdaptiveZoomHide()

InfluxDB2\Model\XYViewProperties::getAdaptiveZoomHide ( )

Gets adaptive_zoom_hide

Returns: bool|null

◆ getAxes()

InfluxDB2\Model\XYViewProperties::getAxes ( )

Gets axes

Returns: \InfluxDB2\Model\Axes

◆ getColorMapping()

InfluxDB2\Model\XYViewProperties::getColorMapping ( )

Gets color_mapping

Returns: map[string,string]|null

◆ getColors()

InfluxDB2\Model\XYViewProperties::getColors ( )

Gets colors

Returns: \InfluxDB2\Model\DashboardColor[]

◆ getGenerateXAxisTicks()

InfluxDB2\Model\XYViewProperties::getGenerateXAxisTicks ( )

Gets generate_x_axis_ticks

Returns: string[]|null

◆ getGenerateYAxisTicks()

InfluxDB2\Model\XYViewProperties::getGenerateYAxisTicks ( )

Gets generate_y_axis_ticks

Returns: string[]|null

◆ getGeom()

InfluxDB2\Model\XYViewProperties::getGeom ( )

Gets geom

Returns: \InfluxDB2\Model\XYGeom

◆ getHoverDimension()

InfluxDB2\Model\XYViewProperties::getHoverDimension ( )

Gets hover_dimension

Returns: string|null

◆ getHoverDimensionAllowableValues()

InfluxDB2\Model\XYViewProperties::getHoverDimensionAllowableValues ( )

Gets allowable values of the enum

Returns: string[]

◆ getLegendColorizeRows()

InfluxDB2\Model\XYViewProperties::getLegendColorizeRows ( )

Gets legend_colorize_rows

Returns: bool|null

◆ getLegendHide()

InfluxDB2\Model\XYViewProperties::getLegendHide ( )

Gets legend_hide

Returns: bool|null

◆ getLegendOpacity()

InfluxDB2\Model\XYViewProperties::getLegendOpacity ( )

Gets legend_opacity

Returns: float|null

◆ getLegendOrientationThreshold()

InfluxDB2\Model\XYViewProperties::getLegendOrientationThreshold ( )

Gets legend_orientation_threshold

Returns: int|null

◆ getModelName()

InfluxDB2\Model\XYViewProperties::getModelName ( )

The original name of the model.

Returns: string

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getNote()

InfluxDB2\Model\XYViewProperties::getNote ( )

Gets note

Returns: string

◆ getPosition()

InfluxDB2\Model\XYViewProperties::getPosition ( )

Gets position

Returns: string

◆ getPositionAllowableValues()

InfluxDB2\Model\XYViewProperties::getPositionAllowableValues ( )

Gets allowable values of the enum

Returns: string[]

◆ getQueries()

InfluxDB2\Model\XYViewProperties::getQueries ( )

Gets queries

Returns: \InfluxDB2\Model\DashboardQuery[]

◆ getShadeBelow()

InfluxDB2\Model\XYViewProperties::getShadeBelow ( )

Gets shade_below

Returns: bool|null

◆ getShape()

InfluxDB2\Model\XYViewProperties::getShape ( )

Gets shape

Returns: string

◆ getShapeAllowableValues()

InfluxDB2\Model\XYViewProperties::getShapeAllowableValues ( )

Gets allowable values of the enum

Returns: string[]

◆ getShowNoteWhenEmpty()

InfluxDB2\Model\XYViewProperties::getShowNoteWhenEmpty ( )

Gets show_note_when_empty

Returns: bool

◆ getStaticLegend()

InfluxDB2\Model\XYViewProperties::getStaticLegend ( )

Gets static_legend

Returns: \InfluxDB2\Model\StaticLegend|null

◆ getters()

static InfluxDB2\Model\XYViewProperties::getters ( )

static

Array of attributes to getter functions (for serialization of requests)

Returns: array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getTimeFormat()

InfluxDB2\Model\XYViewProperties::getTimeFormat ( )

Gets time_format

Returns: string|null

◆ getType()

InfluxDB2\Model\XYViewProperties::getType ( )

Gets type

Returns: string

◆ getTypeAllowableValues()

InfluxDB2\Model\XYViewProperties::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns: string[]

◆ getXColumn()

InfluxDB2\Model\XYViewProperties::getXColumn ( )

Gets x_column

Returns: string|null

◆ getXTickStart()

InfluxDB2\Model\XYViewProperties::getXTickStart ( )

Gets x_tick_start

Returns: float|null

◆ getXTickStep()

InfluxDB2\Model\XYViewProperties::getXTickStep ( )

Gets x_tick_step

Returns: float|null

◆ getXTotalTicks()

InfluxDB2\Model\XYViewProperties::getXTotalTicks ( )

Gets x_total_ticks

Returns: int|null

◆ getYColumn()

InfluxDB2\Model\XYViewProperties::getYColumn ( )

Gets y_column

Returns: string|null

◆ getYTickStart()

InfluxDB2\Model\XYViewProperties::getYTickStart ( )

Gets y_tick_start

Returns: float|null

◆ getYTickStep()

InfluxDB2\Model\XYViewProperties::getYTickStep ( )

Gets y_tick_step

Returns: float|null

◆ getYTotalTicks()

InfluxDB2\Model\XYViewProperties::getYTotalTicks ( )

Gets y_total_ticks

Returns: int|null

◆ listInvalidProperties()

InfluxDB2\Model\XYViewProperties::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns: array invalid properties with reasons

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetExists()

InfluxDB2\Model\XYViewProperties::offsetExists ( $offset )

Returns true if offset exists. False otherwise.

Parameters

integer $offset Offset

Returns: boolean

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetGet()

InfluxDB2\Model\XYViewProperties::offsetGet ( $offset )

Gets offset.

Parameters

integer $offset Offset

Returns: mixed

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetSet()

InfluxDB2\Model\XYViewProperties::offsetSet	(		$offset,
			$value )

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns: void

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetUnset()

InfluxDB2\Model\XYViewProperties::offsetUnset ( $offset )

Unsets offset.

Parameters

integer $offset Offset

Returns: void

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ openAPIFormats()

static InfluxDB2\Model\XYViewProperties::openAPIFormats ( )

static

Array of property to format mappings. Used for (de)serialization

Returns: array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ openAPITypes()

static InfluxDB2\Model\XYViewProperties::openAPITypes ( )

static

Array of property to type mappings. Used for (de)serialization

Returns: array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ setAdaptiveZoomHide()

InfluxDB2\Model\XYViewProperties::setAdaptiveZoomHide ( $adaptive_zoom_hide )

Sets adaptive_zoom_hide

Parameters

bool | null $adaptive_zoom_hide adaptive_zoom_hide

Returns: $this

◆ setAxes()

InfluxDB2\Model\XYViewProperties::setAxes ( $axes )

Sets axes

Parameters

\InfluxDB2\Model\Axes $axes axes

Returns: $this

◆ setColorMapping()

InfluxDB2\Model\XYViewProperties::setColorMapping ( $color_mapping )

Sets color_mapping

Parameters

map[string,string]|null $color_mapping 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: $this

◆ setColors()

InfluxDB2\Model\XYViewProperties::setColors ( $colors )

Sets colors

Parameters

\InfluxDB2\Model\DashboardColor[] $colors Colors define color encoding of data into a visualization

Returns: $this

◆ setGenerateXAxisTicks()

InfluxDB2\Model\XYViewProperties::setGenerateXAxisTicks ( $generate_x_axis_ticks )

Sets generate_x_axis_ticks

Parameters

string[] | null $generate_x_axis_ticks generate_x_axis_ticks

Returns: $this

◆ setGenerateYAxisTicks()

InfluxDB2\Model\XYViewProperties::setGenerateYAxisTicks ( $generate_y_axis_ticks )

Sets generate_y_axis_ticks

Parameters

string[] | null $generate_y_axis_ticks generate_y_axis_ticks

Returns: $this

◆ setGeom()

InfluxDB2\Model\XYViewProperties::setGeom ( $geom )

Sets geom

Parameters

\InfluxDB2\Model\XYGeom $geom geom

Returns: $this

◆ setHoverDimension()

InfluxDB2\Model\XYViewProperties::setHoverDimension ( $hover_dimension )

Sets hover_dimension

Parameters

string | null $hover_dimension hover_dimension

Returns: $this

◆ setLegendColorizeRows()

InfluxDB2\Model\XYViewProperties::setLegendColorizeRows ( $legend_colorize_rows )

Sets legend_colorize_rows

Parameters

bool | null $legend_colorize_rows legend_colorize_rows

Returns: $this

◆ setLegendHide()

InfluxDB2\Model\XYViewProperties::setLegendHide ( $legend_hide )

Sets legend_hide

Parameters

bool | null $legend_hide legend_hide

Returns: $this

◆ setLegendOpacity()

InfluxDB2\Model\XYViewProperties::setLegendOpacity ( $legend_opacity )

Sets legend_opacity

Parameters

float | null $legend_opacity legend_opacity

Returns: $this

◆ setLegendOrientationThreshold()

InfluxDB2\Model\XYViewProperties::setLegendOrientationThreshold ( $legend_orientation_threshold )

Sets legend_orientation_threshold

Parameters

int | null $legend_orientation_threshold legend_orientation_threshold

Returns: $this

◆ setNote()

InfluxDB2\Model\XYViewProperties::setNote ( $note )

Sets note

Parameters

string $note note

Returns: $this

◆ setPosition()

InfluxDB2\Model\XYViewProperties::setPosition ( $position )

Sets position

Parameters

string $position position

Returns: $this

◆ setQueries()

InfluxDB2\Model\XYViewProperties::setQueries ( $queries )

Sets queries

Parameters

\InfluxDB2\Model\DashboardQuery[] $queries queries

Returns: $this

◆ setShadeBelow()

InfluxDB2\Model\XYViewProperties::setShadeBelow ( $shade_below )

Sets shade_below

Parameters

bool | null $shade_below shade_below

Returns: $this

◆ setShape()

InfluxDB2\Model\XYViewProperties::setShape ( $shape )

Sets shape

Parameters

string $shape shape

Returns: $this

◆ setShowNoteWhenEmpty()

InfluxDB2\Model\XYViewProperties::setShowNoteWhenEmpty ( $show_note_when_empty )

Sets show_note_when_empty

Parameters

bool $show_note_when_empty If true, will display note when empty

Returns: $this

◆ setStaticLegend()

InfluxDB2\Model\XYViewProperties::setStaticLegend ( $static_legend )

Sets static_legend

Parameters

\InfluxDB2\Model\StaticLegend | null $static_legend static_legend

Returns: $this

◆ setters()

static InfluxDB2\Model\XYViewProperties::setters ( )

static

Array of attributes to setter functions (for deserialization of responses)

Returns: array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ setTimeFormat()

InfluxDB2\Model\XYViewProperties::setTimeFormat ( $time_format )

Sets time_format

Parameters

string | null $time_format time_format

Returns: $this

◆ setType()

InfluxDB2\Model\XYViewProperties::setType ( $type )

Sets type

Parameters

string $type type

Returns: $this

◆ setXColumn()

InfluxDB2\Model\XYViewProperties::setXColumn ( $x_column )

Sets x_column

Parameters

string | null $x_column x_column

Returns: $this

◆ setXTickStart()

InfluxDB2\Model\XYViewProperties::setXTickStart ( $x_tick_start )

Sets x_tick_start

Parameters

float | null $x_tick_start x_tick_start

Returns: $this

◆ setXTickStep()

InfluxDB2\Model\XYViewProperties::setXTickStep ( $x_tick_step )

Sets x_tick_step

Parameters

float | null $x_tick_step x_tick_step

Returns: $this

◆ setXTotalTicks()

InfluxDB2\Model\XYViewProperties::setXTotalTicks ( $x_total_ticks )

Sets x_total_ticks

Parameters

int | null $x_total_ticks x_total_ticks

Returns: $this

◆ setYColumn()

InfluxDB2\Model\XYViewProperties::setYColumn ( $y_column )

Sets y_column

Parameters

string | null $y_column y_column

Returns: $this

◆ setYTickStart()

InfluxDB2\Model\XYViewProperties::setYTickStart ( $y_tick_start )

Sets y_tick_start

Parameters

float | null $y_tick_start y_tick_start

Returns: $this

◆ setYTickStep()

InfluxDB2\Model\XYViewProperties::setYTickStep ( $y_tick_step )

Sets y_tick_step

Parameters

float | null $y_tick_step y_tick_step

Returns: $this

◆ setYTotalTicks()

InfluxDB2\Model\XYViewProperties::setYTotalTicks ( $y_total_ticks )

Sets y_total_ticks

Parameters

int | null $y_total_ticks y_total_ticks

Returns: $this

◆ valid()

InfluxDB2\Model\XYViewProperties::valid ( )

Validate all the properties in the model return true if all passed

Returns: bool True if all properties are valid

Reimplemented from InfluxDB2\Model\ViewProperties.

The documentation for this class was generated from the following file:

src/InfluxDB2/Model/XYViewProperties.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ attributeMap()

◆ getAdaptiveZoomHide()

◆ getAxes()

◆ getColorMapping()

◆ getColors()

◆ getGenerateXAxisTicks()

◆ getGenerateYAxisTicks()

◆ getGeom()

◆ getHoverDimension()

◆ getHoverDimensionAllowableValues()

◆ getLegendColorizeRows()

◆ getLegendHide()

◆ getLegendOpacity()

◆ getLegendOrientationThreshold()

◆ getModelName()

◆ getNote()

◆ getPosition()

◆ getPositionAllowableValues()

◆ getQueries()

◆ getShadeBelow()

◆ getShape()

◆ getShapeAllowableValues()

◆ getShowNoteWhenEmpty()

◆ getStaticLegend()

◆ getters()

◆ getTimeFormat()

◆ getType()

◆ getTypeAllowableValues()

◆ getXColumn()

◆ getXTickStart()

◆ getXTickStep()

◆ getXTotalTicks()

◆ getYColumn()

◆ getYTickStart()

◆ getYTickStep()

◆ getYTotalTicks()

◆ listInvalidProperties()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ openAPIFormats()

◆ openAPITypes()

◆ setAdaptiveZoomHide()

◆ setAxes()

◆ setColorMapping()

◆ setColors()

◆ setGenerateXAxisTicks()

◆ setGenerateYAxisTicks()

◆ setGeom()

◆ setHoverDimension()

◆ setLegendColorizeRows()

◆ setLegendHide()

◆ setLegendOpacity()

◆ setLegendOrientationThreshold()

◆ setNote()

◆ setPosition()

◆ setQueries()

◆ setShadeBelow()

◆ setShape()

◆ setShowNoteWhenEmpty()

◆ setStaticLegend()

◆ setters()

◆ setTimeFormat()

◆ setType()

◆ setXColumn()

◆ setXTickStart()

◆ setXTickStep()

◆ setXTotalTicks()

◆ setYColumn()

◆ setYTickStart()