InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Attributes | List of all members
InfluxDB2\Model\HeatmapViewProperties Class Reference
Inheritance diagram for InfluxDB2\Model\HeatmapViewProperties:
InfluxDB2\Model\ViewProperties InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 getTypeAllowableValues ()
 
 getShapeAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getAdaptiveZoomHide ()
 
 setAdaptiveZoomHide ($adaptive_zoom_hide)
 
 getTimeFormat ()
 
 setTimeFormat ($time_format)
 
 getType ()
 
 setType ($type)
 
 getQueries ()
 
 setQueries ($queries)
 
 getColors ()
 
 setColors ($colors)
 
 getShape ()
 
 setShape ($shape)
 
 getNote ()
 
 setNote ($note)
 
 getShowNoteWhenEmpty ()
 
 setShowNoteWhenEmpty ($show_note_when_empty)
 
 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)
 
 getXDomain ()
 
 setXDomain ($x_domain)
 
 getYDomain ()
 
 setYDomain ($y_domain)
 
 getXAxisLabel ()
 
 setXAxisLabel ($x_axis_label)
 
 getYAxisLabel ()
 
 setYAxisLabel ($y_axis_label)
 
 getXPrefix ()
 
 setXPrefix ($x_prefix)
 
 getXSuffix ()
 
 setXSuffix ($x_suffix)
 
 getYPrefix ()
 
 setYPrefix ($y_prefix)
 
 getYSuffix ()
 
 setYSuffix ($y_suffix)
 
 getBinSize ()
 
 setBinSize ($bin_size)
 
 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_HEATMAP = 'heatmap'
 
const SHAPE_CHRONOGRAF_V2 = 'chronograf-v2'
 
- Public Attributes inherited from InfluxDB2\Model\ViewProperties
const DISCRIMINATOR = null
 

Static Protected Attributes

static $openAPIModelName = 'HeatmapViewProperties'
 
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\HeatmapViewProperties::__construct ( array $data = null)

Constructor

Parameters
mixed[]$dataAssociated array of property values initializing the model

Reimplemented from InfluxDB2\Model\ViewProperties.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\HeatmapViewProperties::__toString ( )

Gets the string presentation of the object

Returns
string

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ attributeMap()

static InfluxDB2\Model\HeatmapViewProperties::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\HeatmapViewProperties::getAdaptiveZoomHide ( )

Gets adaptive_zoom_hide

Returns
bool|null

◆ getBinSize()

InfluxDB2\Model\HeatmapViewProperties::getBinSize ( )

Gets bin_size

Returns
float

◆ getColors()

InfluxDB2\Model\HeatmapViewProperties::getColors ( )

Gets colors

Returns
string[]

◆ getGenerateXAxisTicks()

InfluxDB2\Model\HeatmapViewProperties::getGenerateXAxisTicks ( )

Gets generate_x_axis_ticks

Returns
string[]|null

◆ getGenerateYAxisTicks()

InfluxDB2\Model\HeatmapViewProperties::getGenerateYAxisTicks ( )

Gets generate_y_axis_ticks

Returns
string[]|null

◆ getLegendColorizeRows()

InfluxDB2\Model\HeatmapViewProperties::getLegendColorizeRows ( )

Gets legend_colorize_rows

Returns
bool|null

◆ getLegendHide()

InfluxDB2\Model\HeatmapViewProperties::getLegendHide ( )

Gets legend_hide

Returns
bool|null

◆ getLegendOpacity()

InfluxDB2\Model\HeatmapViewProperties::getLegendOpacity ( )

Gets legend_opacity

Returns
float|null

◆ getLegendOrientationThreshold()

InfluxDB2\Model\HeatmapViewProperties::getLegendOrientationThreshold ( )

Gets legend_orientation_threshold

Returns
int|null

◆ getModelName()

InfluxDB2\Model\HeatmapViewProperties::getModelName ( )

The original name of the model.

Returns
string

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getNote()

InfluxDB2\Model\HeatmapViewProperties::getNote ( )

Gets note

Returns
string

◆ getQueries()

InfluxDB2\Model\HeatmapViewProperties::getQueries ( )

Gets queries

Returns
\InfluxDB2\Model\DashboardQuery[]

◆ getShape()

InfluxDB2\Model\HeatmapViewProperties::getShape ( )

Gets shape

Returns
string

◆ getShapeAllowableValues()

InfluxDB2\Model\HeatmapViewProperties::getShapeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getShowNoteWhenEmpty()

InfluxDB2\Model\HeatmapViewProperties::getShowNoteWhenEmpty ( )

Gets show_note_when_empty

Returns
bool

◆ getters()

static InfluxDB2\Model\HeatmapViewProperties::getters ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getTimeFormat()

InfluxDB2\Model\HeatmapViewProperties::getTimeFormat ( )

Gets time_format

Returns
string|null

◆ getType()

InfluxDB2\Model\HeatmapViewProperties::getType ( )

Gets type

Returns
string

◆ getTypeAllowableValues()

InfluxDB2\Model\HeatmapViewProperties::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getXAxisLabel()

InfluxDB2\Model\HeatmapViewProperties::getXAxisLabel ( )

Gets x_axis_label

Returns
string

◆ getXColumn()

InfluxDB2\Model\HeatmapViewProperties::getXColumn ( )

Gets x_column

Returns
string

◆ getXDomain()

InfluxDB2\Model\HeatmapViewProperties::getXDomain ( )

Gets x_domain

Returns
float[]

◆ getXPrefix()

InfluxDB2\Model\HeatmapViewProperties::getXPrefix ( )

Gets x_prefix

Returns
string

◆ getXSuffix()

InfluxDB2\Model\HeatmapViewProperties::getXSuffix ( )

Gets x_suffix

Returns
string

◆ getXTickStart()

InfluxDB2\Model\HeatmapViewProperties::getXTickStart ( )

Gets x_tick_start

Returns
float|null

◆ getXTickStep()

InfluxDB2\Model\HeatmapViewProperties::getXTickStep ( )

Gets x_tick_step

Returns
float|null

◆ getXTotalTicks()

InfluxDB2\Model\HeatmapViewProperties::getXTotalTicks ( )

Gets x_total_ticks

Returns
int|null

◆ getYAxisLabel()

InfluxDB2\Model\HeatmapViewProperties::getYAxisLabel ( )

Gets y_axis_label

Returns
string

◆ getYColumn()

InfluxDB2\Model\HeatmapViewProperties::getYColumn ( )

Gets y_column

Returns
string

◆ getYDomain()

InfluxDB2\Model\HeatmapViewProperties::getYDomain ( )

Gets y_domain

Returns
float[]

◆ getYPrefix()

InfluxDB2\Model\HeatmapViewProperties::getYPrefix ( )

Gets y_prefix

Returns
string

◆ getYSuffix()

InfluxDB2\Model\HeatmapViewProperties::getYSuffix ( )

Gets y_suffix

Returns
string

◆ getYTickStart()

InfluxDB2\Model\HeatmapViewProperties::getYTickStart ( )

Gets y_tick_start

Returns
float|null

◆ getYTickStep()

InfluxDB2\Model\HeatmapViewProperties::getYTickStep ( )

Gets y_tick_step

Returns
float|null

◆ getYTotalTicks()

InfluxDB2\Model\HeatmapViewProperties::getYTotalTicks ( )

Gets y_total_ticks

Returns
int|null

◆ listInvalidProperties()

InfluxDB2\Model\HeatmapViewProperties::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetSet()

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

Sets value based on offset.

Parameters
integer$offsetOffset
mixed$valueValue to be set
Returns
void

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ openAPIFormats()

static InfluxDB2\Model\HeatmapViewProperties::openAPIFormats ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ openAPITypes()

static InfluxDB2\Model\HeatmapViewProperties::openAPITypes ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ setAdaptiveZoomHide()

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

Sets adaptive_zoom_hide

Parameters
bool | null$adaptive_zoom_hideadaptive_zoom_hide
Returns
$this

◆ setBinSize()

InfluxDB2\Model\HeatmapViewProperties::setBinSize ( $bin_size)

Sets bin_size

Parameters
float$bin_sizebin_size
Returns
$this

◆ setColors()

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

Sets colors

Parameters
string[]$colorsColors define color encoding of data into a visualization
Returns
$this

◆ setGenerateXAxisTicks()

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

Sets generate_x_axis_ticks

Parameters
string[] | null$generate_x_axis_ticksgenerate_x_axis_ticks
Returns
$this

◆ setGenerateYAxisTicks()

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

Sets generate_y_axis_ticks

Parameters
string[] | null$generate_y_axis_ticksgenerate_y_axis_ticks
Returns
$this

◆ setLegendColorizeRows()

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

Sets legend_colorize_rows

Parameters
bool | null$legend_colorize_rowslegend_colorize_rows
Returns
$this

◆ setLegendHide()

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

Sets legend_hide

Parameters
bool | null$legend_hidelegend_hide
Returns
$this

◆ setLegendOpacity()

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

Sets legend_opacity

Parameters
float | null$legend_opacitylegend_opacity
Returns
$this

◆ setLegendOrientationThreshold()

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

Sets legend_orientation_threshold

Parameters
int | null$legend_orientation_thresholdlegend_orientation_threshold
Returns
$this

◆ setNote()

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

Sets note

Parameters
string$notenote
Returns
$this

◆ setQueries()

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

Sets queries

Parameters
\InfluxDB2\Model\DashboardQuery[]$queriesqueries
Returns
$this

◆ setShape()

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

Sets shape

Parameters
string$shapeshape
Returns
$this

◆ setShowNoteWhenEmpty()

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

Sets show_note_when_empty

Parameters
bool$show_note_when_emptyIf true, will display note when empty
Returns
$this

◆ setters()

static InfluxDB2\Model\HeatmapViewProperties::setters ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ setTimeFormat()

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

Sets time_format

Parameters
string | null$time_formattime_format
Returns
$this

◆ setType()

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

Sets type

Parameters
string$typetype
Returns
$this

◆ setXAxisLabel()

InfluxDB2\Model\HeatmapViewProperties::setXAxisLabel ( $x_axis_label)

Sets x_axis_label

Parameters
string$x_axis_labelx_axis_label
Returns
$this

◆ setXColumn()

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

Sets x_column

Parameters
string$x_columnx_column
Returns
$this

◆ setXDomain()

InfluxDB2\Model\HeatmapViewProperties::setXDomain ( $x_domain)

Sets x_domain

Parameters
float[]$x_domainx_domain
Returns
$this

◆ setXPrefix()

InfluxDB2\Model\HeatmapViewProperties::setXPrefix ( $x_prefix)

Sets x_prefix

Parameters
string$x_prefixx_prefix
Returns
$this

◆ setXSuffix()

InfluxDB2\Model\HeatmapViewProperties::setXSuffix ( $x_suffix)

Sets x_suffix

Parameters
string$x_suffixx_suffix
Returns
$this

◆ setXTickStart()

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

Sets x_tick_start

Parameters
float | null$x_tick_startx_tick_start
Returns
$this

◆ setXTickStep()

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

Sets x_tick_step

Parameters
float | null$x_tick_stepx_tick_step
Returns
$this

◆ setXTotalTicks()

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

Sets x_total_ticks

Parameters
int | null$x_total_ticksx_total_ticks
Returns
$this

◆ setYAxisLabel()

InfluxDB2\Model\HeatmapViewProperties::setYAxisLabel ( $y_axis_label)

Sets y_axis_label

Parameters
string$y_axis_labely_axis_label
Returns
$this

◆ setYColumn()

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

Sets y_column

Parameters
string$y_columny_column
Returns
$this

◆ setYDomain()

InfluxDB2\Model\HeatmapViewProperties::setYDomain ( $y_domain)

Sets y_domain

Parameters
float[]$y_domainy_domain
Returns
$this

◆ setYPrefix()

InfluxDB2\Model\HeatmapViewProperties::setYPrefix ( $y_prefix)

Sets y_prefix

Parameters
string$y_prefixy_prefix
Returns
$this

◆ setYSuffix()

InfluxDB2\Model\HeatmapViewProperties::setYSuffix ( $y_suffix)

Sets y_suffix

Parameters
string$y_suffixy_suffix
Returns
$this

◆ setYTickStart()

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

Sets y_tick_start

Parameters
float | null$y_tick_starty_tick_start
Returns
$this

◆ setYTickStep()

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

Sets y_tick_step

Parameters
float | null$y_tick_stepy_tick_step
Returns
$this

◆ setYTotalTicks()

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

Sets y_total_ticks

Parameters
int | null$y_total_ticksy_total_ticks
Returns
$this

◆ valid()

InfluxDB2\Model\HeatmapViewProperties::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:
Generated by doxygen 1.10.0