Contentserv PHP API

CSWhiteboardSketchNote
in package

Class CSWhiteboardSketchNote

Tags
access

public

since

CS13.0

Table of Contents

getCometGroup()  : int
Returns the Comet Group of a note
getHeight()  : float
Returns the height of the SKetch Note
getNote()  : float
Returns the note
getPageID()  : int
Returns the Page ID of the Sketch Note
getPositionLeft()  : float
Returns the left position
getPositionTop()  : float
Returns the top position
getReferenceID()  : int
Returns the referenceID of the Sketch Note
getWidth()  : float
Returns the width of the Sketch Note
setCometGroup()  : mixed
Sets the comet group the note is attached to
setHeight()  : mixed
Sets the height of the Sketch Note
setNote()  : mixed
Sets the note
setPageID()  : mixed
Sets the Page ID of the Sketch Note
setPositionLeft()  : mixed
Sets the left position
setPositionTop()  : mixed
Sets the top position
setReferenceID()  : mixed
Sets the referenceID of the Sketch Note
setWidth()  : mixed
Sets the width of the Sketch Note

Methods

getCometGroup()

Returns the Comet Group of a note

public getCometGroup() : int
Tags
access

public

Return values
int

getHeight()

Returns the height of the SKetch Note

public getHeight() : float
Tags
Return values
float

getPageID()

Returns the Page ID of the Sketch Note

public getPageID() : int
Tags
Return values
int

getPositionLeft()

Returns the left position

public getPositionLeft() : float
Tags
access

public

Return values
float

getPositionTop()

Returns the top position

public getPositionTop() : float
Tags
access

public

Return values
float

getReferenceID()

Returns the referenceID of the Sketch Note

public getReferenceID() : int
Tags
Return values
int

getWidth()

Returns the width of the Sketch Note

public getWidth() : float
Tags
Return values
float

setCometGroup()

Sets the comet group the note is attached to

public setCometGroup(int $cometGroup) : mixed
Parameters
$cometGroup : int
Tags
access

public

Return values
mixed

setHeight()

Sets the height of the Sketch Note

public setHeight(float $height) : mixed
Parameters
$height : float
Tags
Return values
mixed

setNote()

Sets the note

public setNote(float $note) : mixed
Parameters
$note : float
Tags
access

public

Return values
mixed

setPageID()

Sets the Page ID of the Sketch Note

public setPageID(int $pageID) : mixed
Parameters
$pageID : int
Tags
Return values
mixed

setPositionLeft()

Sets the left position

public setPositionLeft(float $positionLeft) : mixed
Parameters
$positionLeft : float
Tags
access

public

Return values
mixed

setPositionTop()

Sets the top position

public setPositionTop(float $positionTop) : mixed
Parameters
$positionTop : float
Tags
access

public

Return values
mixed

setReferenceID()

Sets the referenceID of the Sketch Note

public setReferenceID(int $referenceID) : mixed
Parameters
$referenceID : int
Tags
Return values
mixed

setWidth()

Sets the width of the Sketch Note

public setWidth(float $width) : mixed
Parameters
$width : float
Tags
Return values
mixed

        

Search results