Documentation

OverlayArrowItem

in package

• BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

OverlayArrowItem Class Doc Comment

Tags

category

Class

author

OpenAPI Generator team

link

https://openapi-generator.tech

implements

Table of Contents

Interfaces

ModelInterface

Interface abstracting model access.

ArrayAccess

JsonSerializable

Constants

DEPTH_ALWAYS  : mixed = 'always'

DEPTH_GHOST  : mixed = 'ghost'

DEPTH_TEST  : mixed = 'test'

DISCRIMINATOR  : mixed = null

LABEL_SHOW_ALWAYS  : mixed = 'always'

LABEL_SHOW_HOVER  : mixed = 'hover'

ROLE_AREA  : mixed = 'area'

ROLE_HAZARD  : mixed = 'hazard'

ROLE_INFO  : mixed = 'info'

ROLE_NEUTRAL  : mixed = 'neutral'

ROLE_OK  : mixed = 'ok'

ROLE_ROUTE  : mixed = 'route'

ROLE_WARNING  : mixed = 'warning'

SIZE_SCREEN  : mixed = 'screen'

SIZE_WORLD  : mixed = 'world'

VIEWS__2D  : mixed = '2d'

VIEWS__3D  : mixed = '3d'

Properties

$attributeMap  : array<string|int, string>

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

$container  : array<string|int, mixed>

Associative array for storing property values

$getters  : array<string|int, string>

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

$openAPIFormats  : array<string|int, string>

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

$openAPIModelName  : string

The original name of the model.

$openAPINullables  : array<string|int, bool>

Array of nullable properties. Used for (de)serialization

$openAPINullablesSetToNull  : array<string|int, bool>

If a nullable field gets set to null, insert it here

$openAPITypes  : array<string|int, string>

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

$setters  : array<string|int, string>

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

Methods

__construct()  : mixed

Constructor

__toString()  : string

Gets the string presentation of the object

attributeMap()  : array<string|int, mixed>

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

getColor()  : string|null

Gets color

getDepth()  : string|null

Gets depth

getDepthAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getDirection()  : array<string|int, float>

Gets direction

getHeadLength()  : float|null

Gets head_length

getId()  : string

Gets id

getLabel()  : string|null

Gets label

getLabelShow()  : string|null

Gets label_show

getLabelShowAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getLength()  : float|null

Gets length

getModelName()  : string

The original name of the model.

getOrigin()  : array<string|int, float>

Gets origin

getQids()  : array<string|int, string>|null

Gets qids

getRole()  : string|null

Gets role

getRoleAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getSize()  : string|null

Gets size

getSizeAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

getStorey()  : string|null

Gets storey

getters()  : array<string|int, mixed>

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

getTooltip()  : string|null

Gets tooltip

getType()  : string

Gets type

getViews()  : array<string|int, string>|null

Gets views

getViewsAllowableValues()  : array<string|int, string>

Gets allowable values of the enum

isNullable()  : bool

Checks if a property is nullable

isNullableSetToNull()  : bool

Checks if a nullable property is set to null.

jsonSerialize()  : mixed

Serializes the object to a value that can be serialized natively by json_encode().

listInvalidProperties()  : array<string|int, mixed>

Show all the invalid properties with reasons.

offsetExists()  : bool

Returns true if offset exists. False otherwise.

offsetGet()  : mixed|null

Gets offset.

offsetSet()  : void

Sets value based on offset.

offsetUnset()  : void

Unsets offset.

openAPIFormats()  : array<string|int, mixed>

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

openAPITypes()  : array<string|int, mixed>

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

setColor()  : self

Sets color

setDepth()  : self

Sets depth

setDirection()  : self

Sets direction

setHeadLength()  : self

Sets head_length

setId()  : self

Sets id

setLabel()  : self

Sets label

setLabelShow()  : self

Sets label_show

setLength()  : self

Sets length

setOrigin()  : self

Sets origin

setQids()  : self

Sets qids

setRole()  : self

Sets role

setSize()  : self

Sets size

setStorey()  : self

Sets storey

setters()  : array<string|int, mixed>

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

setTooltip()  : self

Sets tooltip

setType()  : self

Sets type

setViews()  : self

Sets views

toHeaderValue()  : string

Gets a header-safe presentation of the object

valid()  : bool

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

openAPINullables()  : array<string|int, mixed>

Array of nullable properties

getOpenAPINullablesSetToNull()  : array<string|int, bool>

Array of nullable field names deliberately set to null

setIfExists()  : void

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

setOpenAPINullablesSetToNull()  : void

Setter - Array of nullable field names deliberately set to null