InfluxDB2\Model\HistogramViewProperties Class Reference

Inheritance diagram for InfluxDB2\Model\HistogramViewProperties:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	getShapeAllowableValues ()
	getPositionAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	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)
	getFillColumns ()
	setFillColumns ($fill_columns)
	getXDomain ()
	setXDomain ($x_domain)
	getXAxisLabel ()
	setXAxisLabel ($x_axis_label)
	getPosition ()
	setPosition ($position)
	getBinCount ()
	setBinCount ($bin_count)
	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_HISTOGRAM = 'histogram'
const	SHAPE_CHRONOGRAF_V2 = 'chronograf-v2'
const	POSITION_OVERLAID = 'overlaid'
const	POSITION_STACKED = 'stacked'
Public Attributes inherited from InfluxDB2\Model\ViewProperties
const	DISCRIMINATOR = null

Static Protected Attributes
static	$openAPIModelName = 'HistogramViewProperties'
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\HistogramViewProperties::__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\HistogramViewProperties::__toString

(

)

Gets the string presentation of the object

Returns

string

Reimplemented from InfluxDB2\Model\ViewProperties.

attributeMap()

static InfluxDB2\Model\HistogramViewProperties::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.

getBinCount()

InfluxDB2\Model\HistogramViewProperties::getBinCount

(

)

Gets bin_count

Returns

int

getColors()

InfluxDB2\Model\HistogramViewProperties::getColors

(

)

Gets colors

Returns

\InfluxDB2\Model\DashboardColor[]

getFillColumns()

InfluxDB2\Model\HistogramViewProperties::getFillColumns

(

)

Gets fill_columns

Returns

string[]

getLegendColorizeRows()

InfluxDB2\Model\HistogramViewProperties::getLegendColorizeRows

(

)

Gets legend_colorize_rows

Returns

bool|null

getLegendHide()

InfluxDB2\Model\HistogramViewProperties::getLegendHide

(

)

Gets legend_hide

Returns

bool|null

getLegendOpacity()

InfluxDB2\Model\HistogramViewProperties::getLegendOpacity

(

)

Gets legend_opacity

Returns

float|null

getLegendOrientationThreshold()

InfluxDB2\Model\HistogramViewProperties::getLegendOrientationThreshold

(

)

Gets legend_orientation_threshold

Returns

int|null

getModelName()

InfluxDB2\Model\HistogramViewProperties::getModelName

(

)

The original name of the model.

Returns

string

Reimplemented from InfluxDB2\Model\ViewProperties.

getNote()

InfluxDB2\Model\HistogramViewProperties::getNote

(

)

Gets note

Returns

string

getPosition()

InfluxDB2\Model\HistogramViewProperties::getPosition

(

)

Gets position

Returns

string

getPositionAllowableValues()

InfluxDB2\Model\HistogramViewProperties::getPositionAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getQueries()

InfluxDB2\Model\HistogramViewProperties::getQueries

(

)

Gets queries

Returns

\InfluxDB2\Model\DashboardQuery[]

getShape()

InfluxDB2\Model\HistogramViewProperties::getShape

(

)

Gets shape

Returns

string

getShapeAllowableValues()

InfluxDB2\Model\HistogramViewProperties::getShapeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getShowNoteWhenEmpty()

InfluxDB2\Model\HistogramViewProperties::getShowNoteWhenEmpty

(

)

Gets show_note_when_empty

Returns

bool

getters()

static InfluxDB2\Model\HistogramViewProperties::getters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\ViewProperties.

getType()

InfluxDB2\Model\HistogramViewProperties::getType

(

)

Gets type

Returns

string

getTypeAllowableValues()

InfluxDB2\Model\HistogramViewProperties::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getXAxisLabel()

InfluxDB2\Model\HistogramViewProperties::getXAxisLabel

(

)

Gets x_axis_label

Returns

string

getXColumn()

InfluxDB2\Model\HistogramViewProperties::getXColumn

(

)

Gets x_column

Returns

string

getXDomain()

InfluxDB2\Model\HistogramViewProperties::getXDomain

(

)

Gets x_domain

Returns

float[]

listInvalidProperties()

InfluxDB2\Model\HistogramViewProperties::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Reimplemented from InfluxDB2\Model\ViewProperties.

offsetExists()

InfluxDB2\Model\HistogramViewProperties::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

Reimplemented from InfluxDB2\Model\ViewProperties.

offsetGet()

InfluxDB2\Model\HistogramViewProperties::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

Reimplemented from InfluxDB2\Model\ViewProperties.

offsetSet()

InfluxDB2\Model\HistogramViewProperties::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\HistogramViewProperties::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

Reimplemented from InfluxDB2\Model\ViewProperties.

openAPIFormats()

static InfluxDB2\Model\HistogramViewProperties::openAPIFormats ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\ViewProperties.

openAPITypes()

static InfluxDB2\Model\HistogramViewProperties::openAPITypes ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\ViewProperties.

setBinCount()

InfluxDB2\Model\HistogramViewProperties::setBinCount

(

$bin_count

)

Sets bin_count

Parameters

int

$bin_count

bin_count

Returns

$this

setColors()

InfluxDB2\Model\HistogramViewProperties::setColors

(

$colors

)

Sets colors

Parameters

\InfluxDB2\Model\DashboardColor[]

$colors

Colors define color encoding of data into a visualization

Returns

$this

setFillColumns()

InfluxDB2\Model\HistogramViewProperties::setFillColumns

(

$fill_columns

)

Sets fill_columns

Parameters

string[]

$fill_columns

fill_columns

Returns

$this

setLegendColorizeRows()

InfluxDB2\Model\HistogramViewProperties::setLegendColorizeRows

(

$legend_colorize_rows

)

Sets legend_colorize_rows

Parameters

bool | null

$legend_colorize_rows

legend_colorize_rows

Returns

$this

setLegendHide()

InfluxDB2\Model\HistogramViewProperties::setLegendHide

(

$legend_hide

)

Sets legend_hide

Parameters

bool | null

$legend_hide

legend_hide

Returns

$this

setLegendOpacity()

InfluxDB2\Model\HistogramViewProperties::setLegendOpacity

(

$legend_opacity

)

Sets legend_opacity

Parameters

float | null

$legend_opacity

legend_opacity

Returns

$this

setLegendOrientationThreshold()

InfluxDB2\Model\HistogramViewProperties::setLegendOrientationThreshold

(

$legend_orientation_threshold

)

Sets legend_orientation_threshold

Parameters

int | null

$legend_orientation_threshold

legend_orientation_threshold

Returns

$this

setNote()

InfluxDB2\Model\HistogramViewProperties::setNote

(

$note

)

Sets note

Parameters

string

$note

note

Returns

$this

setPosition()

InfluxDB2\Model\HistogramViewProperties::setPosition

(

$position

)

Sets position

Parameters

string

$position

position

Returns

$this

setQueries()

InfluxDB2\Model\HistogramViewProperties::setQueries

(

$queries

)

Sets queries

Parameters

\InfluxDB2\Model\DashboardQuery[]

$queries

queries

Returns

$this

setShape()

InfluxDB2\Model\HistogramViewProperties::setShape

(

$shape

)

Sets shape

Parameters

string

$shape

shape

Returns

$this

setShowNoteWhenEmpty()

InfluxDB2\Model\HistogramViewProperties::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

setters()

static InfluxDB2\Model\HistogramViewProperties::setters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\ViewProperties.

setType()

InfluxDB2\Model\HistogramViewProperties::setType

(

$type

)

Sets type

Parameters

string

$type

type

Returns

$this

setXAxisLabel()

InfluxDB2\Model\HistogramViewProperties::setXAxisLabel

(

$x_axis_label

)

Sets x_axis_label

Parameters

string

$x_axis_label

x_axis_label

Returns

$this

setXColumn()

InfluxDB2\Model\HistogramViewProperties::setXColumn

(

$x_column

)

Sets x_column

Parameters

string

$x_column

x_column

Returns

$this

setXDomain()

InfluxDB2\Model\HistogramViewProperties::setXDomain

(

$x_domain

)

Sets x_domain

Parameters

float[]

$x_domain

x_domain

Returns

$this

valid()

InfluxDB2\Model\HistogramViewProperties::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.

Member Data Documentation

$attributeMap

InfluxDB2\Model\HistogramViewProperties::$attributeMap

staticprotected

Initial value:

= [
        'type' => 'type',
        'queries' => 'queries',
        'colors' => 'colors',
        'shape' => 'shape',
        'note' => 'note',
        'show_note_when_empty' => 'showNoteWhenEmpty',
        'x_column' => 'xColumn',
        'fill_columns' => 'fillColumns',
        'x_domain' => 'xDomain',
        'x_axis_label' => 'xAxisLabel',
        'position' => 'position',
        'bin_count' => 'binCount',
        'legend_colorize_rows' => 'legendColorizeRows',
        'legend_hide' => 'legendHide',
        'legend_opacity' => 'legendOpacity',
        'legend_orientation_threshold' => 'legendOrientationThreshold'
    ]

$getters

InfluxDB2\Model\HistogramViewProperties::$getters

staticprotected

Initial value:

= [
        'type' => 'getType',
        'queries' => 'getQueries',
        'colors' => 'getColors',
        'shape' => 'getShape',
        'note' => 'getNote',
        'show_note_when_empty' => 'getShowNoteWhenEmpty',
        'x_column' => 'getXColumn',
        'fill_columns' => 'getFillColumns',
        'x_domain' => 'getXDomain',
        'x_axis_label' => 'getXAxisLabel',
        'position' => 'getPosition',
        'bin_count' => 'getBinCount',
        'legend_colorize_rows' => 'getLegendColorizeRows',
        'legend_hide' => 'getLegendHide',
        'legend_opacity' => 'getLegendOpacity',
        'legend_orientation_threshold' => 'getLegendOrientationThreshold'
    ]

$openAPIFormats

InfluxDB2\Model\HistogramViewProperties::$openAPIFormats

staticprotected

Initial value:

= [
        'type' => null,
        'queries' => null,
        'colors' => null,
        'shape' => null,
        'note' => null,
        'show_note_when_empty' => null,
        'x_column' => null,
        'fill_columns' => null,
        'x_domain' => 'float',
        'x_axis_label' => null,
        'position' => null,
        'bin_count' => 'int32',
        'legend_colorize_rows' => null,
        'legend_hide' => null,
        'legend_opacity' => 'float',
        'legend_orientation_threshold' => 'int32'
    ]

$openAPITypes

InfluxDB2\Model\HistogramViewProperties::$openAPITypes

staticprotected

Initial value:

= [
        'type' => 'string',
        'queries' => '\InfluxDB2\Model\DashboardQuery[]',
        'colors' => '\InfluxDB2\Model\DashboardColor[]',
        'shape' => 'string',
        'note' => 'string',
        'show_note_when_empty' => 'bool',
        'x_column' => 'string',
        'fill_columns' => 'string[]',
        'x_domain' => 'float[]',
        'x_axis_label' => 'string',
        'position' => 'string',
        'bin_count' => 'int',
        'legend_colorize_rows' => 'bool',
        'legend_hide' => 'bool',
        'legend_opacity' => 'float',
        'legend_orientation_threshold' => 'int'
    ]

$setters

InfluxDB2\Model\HistogramViewProperties::$setters

staticprotected

Initial value:

= [
        'type' => 'setType',
        'queries' => 'setQueries',
        'colors' => 'setColors',
        'shape' => 'setShape',
        'note' => 'setNote',
        'show_note_when_empty' => 'setShowNoteWhenEmpty',
        'x_column' => 'setXColumn',
        'fill_columns' => 'setFillColumns',
        'x_domain' => 'setXDomain',
        'x_axis_label' => 'setXAxisLabel',
        'position' => 'setPosition',
        'bin_count' => 'setBinCount',
        'legend_colorize_rows' => 'setLegendColorizeRows',
        'legend_hide' => 'setLegendHide',
        'legend_opacity' => 'setLegendOpacity',
        'legend_orientation_threshold' => 'setLegendOrientationThreshold'
    ]

---

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

• src/InfluxDB2/Model/HistogramViewProperties.php