JSDoc: Class: Tuple

new Tuple()

A general purpose tuple.

Source:

tuple.js, line 39

Methods

addBoolean(value) → {Tuple}

Add a boolean value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	boolean	the value

Source:

tuple.js, line 402

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addBox(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 636

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addBuffer(value) → {Tuple}

Add a buffer value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Buffer	the value

Source:

tuple.js, line 564

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addCircle(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 690

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addDouble(value) → {Tuple}

Add a double value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	number	the value

Source:

tuple.js, line 510

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addFloat(value) → {Tuple}

Add a float value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	number	the value

Source:

tuple.js, line 492

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addInteger(value) → {Tuple}

Add an integer value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	number	the value

Source:

tuple.js, line 456

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addInterval(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 708

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addJson(value) → {Tuple}

Add a json value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Json	the value

Source:

tuple.js, line 546

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addLine(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 600

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addLineSegment(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 618

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addLong(value) → {Tuple}

Add a long value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	number	the value

Source:

tuple.js, line 474

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addPath(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 654

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addPoint(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 582

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addPolygon(value) → {Tuple}

Add a value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 672

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addShort(value) → {Tuple}

Add a short value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	number	the value

Source:

tuple.js, line 438

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addString(value) → {Tuple}

Add a string value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	string	the value

Source:

tuple.js, line 528

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

addValue(value) → {Tuple}

Add an object value at the end of the tuple.

Parameters:

Name	Type	Description
`value`	Object	the value

Source:

tuple.js, line 420

Returns:

a reference to this, so the API can be used fluently

Type: Tuple

clear()

Source:

tuple.js, line 740

getBoolean(pos) → {boolean}

Get a boolean value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 96

Returns:

the value or null

Type: boolean

getBox(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 300

Returns:

the value or null

Type: Object

getBuffer(pos) → {Buffer}

Get a buffer value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 385

Returns:

the value or null

Type: Buffer

getCircle(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 351

Returns:

the value or null

Type: Object

getDouble(pos) → {number}

Get a double value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 198

Returns:

the value or null

Type: number

getFloat(pos) → {number}

Get a float value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 181

Returns:

the value or null

Type: number

getInteger(pos) → {number}

Get an integer value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 147

Returns:

the value or null

Type: number

getInterval(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 368

Returns:

the value or null

Type: Object

getJson(pos) → {Json}

Get a json value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 232

Returns:

the value or null

Type: Json

getLine(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 266

Returns:

the value or null

Type: Object

getLineSegment(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 283

Returns:

the value or null

Type: Object

getLong(pos) → {number}

Get a long value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 164

Returns:

the value or null

Type: number

getPath(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 317

Returns:

the value or null

Type: Object

getPoint(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 249

Returns:

the value or null

Type: Object

getPolygon(pos) → {Object}

Get value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 334

Returns:

the value or null

Type: Object

getShort(pos) → {number}

Get a short value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 130

Returns:

the value or null

Type: number

getString(pos) → {string}

Get a string value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 215

Returns:

the value or null

Type: string

getValue(pos) → {Object}

Get an object value at pos.

Parameters:

Name	Type	Description
`pos`	number	the position

Source:

tuple.js, line 113

Returns:

the value or null

Type: Object

size() → {number}

Source:

tuple.js, line 725

Returns:

the tuple size

Type: number