Sharing Services API Reference (JavaScript) Class: AnnotationShapeInfo

Class to store annotation information for the webpage

The AnnotationShapeInfo instance, is created to annotate on the webpage.

The constructor for AnnotationShapeInfo class has optional parameters
{String} [strokeColor=red] Annotation stroke color
{String} [strokeSize=5] Annotation stroke size
{AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeType} [annotationShapeType = AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeType.ANNOTATIONSHAPETYPEFREEHAND] Annotation shape type

AnnotationShapeInfo(strokeColor, strokeSize, annotationShapeType)
{
...
}

Example

Creating instance for AnnotationShapeInfo with default values

// Create AnnotationInfo instance with default values strokeColor= red, strokeSize=5, annotationShapeType = AnnotationShapeType.ANNOTATIONSHAPETYPEFREEHAND
var annotationInfo  = new AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeInfo();

// Create AnnotationInfo instance with user specified values to annotate using rectangle shape
var annotationInfo = new AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeInfo('blue', '11', AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeType.ANNOTATIONSHAPETYPERECTANGLE);

Methods

setAnnotationType(annotationShapeType) → {void}

Parameters:

Name	Type	Argument	Default	Description
`annotationShapeType`	AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeType	<optional>	AvayaCoBrowseClientServices.Services.Cobrowse.Common.AnnotationShapeType.ANNOTATIONSHAPETYPEFREEHAND	Set shape type for the annotation

Returns:

{ void }

setStrokeColor(strokeColor) → {void}

Parameters:

Name	Type	Argument	Default	Description
`strokeColor`	String	<optional>	red	Set color for the annotation shape

Returns:

{ void }

setStrokeSize(strokeSize) → {void}

Parameters:

Name	Type	Argument	Default	Description
`strokeSize`	String	<optional>	5	Set strokesize for the annotation shape

Returns:

{ void }