InfluxDB2\Model\DashboardColor Class Reference

Inheritance diagram for InfluxDB2\Model\DashboardColor:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getId ()
	setId ($id)
	getType ()
	setType ($type)
	getHex ()
	setHex ($hex)
	getName ()
	setName ($name)
	getValue ()
	setValue ($value)
	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_MIN = 'min'
const	TYPE_MAX = 'max'
const	TYPE_THRESHOLD = 'threshold'
const	TYPE_SCALE = 'scale'
const	TYPE_TEXT = 'text'
const	TYPE_BACKGROUND = 'background'

Protected Attributes
	$container = []

Static Protected Attributes
static	$openAPIModelName = 'DashboardColor'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\DashboardColor::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\DashboardColor::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

static InfluxDB2\Model\DashboardColor::attributeMap ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getHex()

InfluxDB2\Model\DashboardColor::getHex

(

)

Gets hex

Returns

string

getId()

InfluxDB2\Model\DashboardColor::getId

(

)

Gets id

Returns

string

getModelName()

InfluxDB2\Model\DashboardColor::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getName()

InfluxDB2\Model\DashboardColor::getName

(

)

Gets name

Returns

string

getters()

static InfluxDB2\Model\DashboardColor::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getType()

InfluxDB2\Model\DashboardColor::getType

(

)

Gets type

Returns

string

getTypeAllowableValues()

InfluxDB2\Model\DashboardColor::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getValue()

InfluxDB2\Model\DashboardColor::getValue

(

)

Gets value

Returns

float

listInvalidProperties()

InfluxDB2\Model\DashboardColor::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\DashboardColor::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\DashboardColor::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\DashboardColor::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\DashboardColor::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\DashboardColor::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setHex()

InfluxDB2\Model\DashboardColor::setHex

(

$hex

)

Sets hex

Parameters

string

$hex

The hex number of the color

Returns

$this

setId()

InfluxDB2\Model\DashboardColor::setId

(

$id

)

Sets id

Parameters

string

$id

The unique ID of the view color.

Returns

$this

setName()

InfluxDB2\Model\DashboardColor::setName

(

$name

)

Sets name

Parameters

string

$name

The user-facing name of the hex color.

Returns

$this

setters()

static InfluxDB2\Model\DashboardColor::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setType()

InfluxDB2\Model\DashboardColor::setType

(

$type

)

Sets type

Parameters

string

$type

Type is how the color is used.

Returns

$this

setValue()

InfluxDB2\Model\DashboardColor::setValue

(

$value

)

Sets value

Parameters

float

$value

The data value mapped to this color.

Returns

$this

valid()

InfluxDB2\Model\DashboardColor::valid

(

)

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

Returns

bool True if all properties are valid

Implements InfluxDB2\Model\ModelInterface.

Member Data Documentation

$attributeMap

InfluxDB2\Model\DashboardColor::$attributeMap

staticprotected

Initial value:

= [
        'id' => 'id',
        'type' => 'type',
        'hex' => 'hex',
        'name' => 'name',
        'value' => 'value'
    ]

$getters

InfluxDB2\Model\DashboardColor::$getters

staticprotected

Initial value:

= [
        'id' => 'getId',
        'type' => 'getType',
        'hex' => 'getHex',
        'name' => 'getName',
        'value' => 'getValue'
    ]

$openAPIFormats

InfluxDB2\Model\DashboardColor::$openAPIFormats

staticprotected

Initial value:

= [
        'id' => null,
        'type' => null,
        'hex' => null,
        'name' => null,
        'value' => 'float'
    ]

$openAPITypes

InfluxDB2\Model\DashboardColor::$openAPITypes

staticprotected

Initial value:

= [
        'id' => 'string',
        'type' => 'string',
        'hex' => 'string',
        'name' => 'string',
        'value' => 'float'
    ]

$setters

InfluxDB2\Model\DashboardColor::$setters

staticprotected

Initial value:

= [
        'id' => 'setId',
        'type' => 'setType',
        'hex' => 'setHex',
        'name' => 'setName',
        'value' => 'setValue'
    ]

---

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

• src/InfluxDB2/Model/DashboardColor.php