CADViewer: JSDoc API

cvjs_activateSpaceObjectModal_Id(rmid)

Activate modal on Space Object

Parameters:

Name	Type	Description
`rmid`	string	Id of space object modal to activate

Source:

cadviewer_pro_6_2_66.js, line 40634

cvjs_activateSpaceObjectModal_Node(node)

Activate modal on Space Object

Parameters:

Name	Type	Description
`node`	string	Node of space object modal to activate

Source:

cadviewer_pro_6_2_66.js, line 40646

cvjs_addCircleSpaceObject(floorplan_div)

Add a Space Object Circle

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 23875

cvjs_addDragRectangleImageSpaceObject(floorplan_div)

Add a Drag Size Size Image Space Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 33298

cvjs_addFixedSizeCustomSpaceObject(floorplan_div, svgImagePath, spaceObjectId, spaceObjectName, spaceObjectType, layer)

Add a Fixed Size Space Object Custom Rectangle

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`svgImagePath`	string	name of path containing wallpaper object
`spaceObjectId`	string	Unique ID of the space object. NOTE!
`spaceObjectName`	string	Name of the space object.
`spaceObjectType`	string	Type of the object
`layer`	string	the associated layer of the object

Source:

cadviewer_pro_6_2_66.js, line 32380

cvjs_addFixedSizeCustomSpaceObjectXY(floorplan_div, svgImagePath, spaceObjectId, spaceObjectName, spaceObjectType, layer, xcor, ycor, coordinate_flag, textArray, scaleFactor, textStyles, scaleText, hexColorText, leftFactor)

Add a Fixed Size Space Object Custom Rectangle at coordinates x, y

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`svgImagePath`	string	name of path containing wallpaper object
`spaceObjectId`	string	Unique ID of the space object. NOTE!
`spaceObjectName`	string	Name of the space object.
`spaceObjectType`	string	Type of the object
`layer`	string	the associated layer of the object
`xcor`	int	x coordinate
`ycor`	int	y coordinate
`coordinate_flag`	int	0 is SVG coordinates, 1 is DWG coordinates, 0 is default
`textArray`	Object	array with lines of text content in Space Object
`scaleFactor`	float	scale factor at insertion, 1.0 is default
`textStyles`	Object	object containing colors and style of each line of text in the Space Object
`scaleText`	Array	array containing relative size af each line of text in the Space Object
`hexColorText`	Array	array containing color of each line of text in the Space Object
`leftFactor`	float	left adjustment factor of text in the Space Object

Source:

cadviewer_pro_6_2_66.js, line 32222

cvjs_addFixedSizeImageSpaceObject(floorplan_div)

Add a Fixed Size Image Space Object with

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 33284

cvjs_addFixedSizeImageSpaceObjectXY(floorplan_div, xcor, ycor)

Add a Fixed Size Image Space Object with

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`xcor`	int	x coordinate in SVG coordinates
`ycor`	int	y coordinate in SVG coordinates

Source:

cadviewer_pro_6_2_66.js, line 33268

cvjs_addPinMarker(floorplan_div, spaceObjectId, spaceObjectName, spaceObjectType, layer)

Add a Pin Marker Space Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`spaceObjectId`	string	Unique ID of the space object. NOTE!
`spaceObjectName`	string	Name of the space object.
`spaceObjectType`	string	Type of the object
`layer`	string	the associated layer of the object

Source:

cadviewer_pro_6_2_66.js, line 30493

cvjs_addPolygonSpaceObject(floorplan_div)

Add a Space Object Polygon

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 23789

cvjs_addRectangleCustomSpaceObject(floorplan_div, svgImagePath, spaceObjectId, spaceObjectName, spaceObjectType, layer)

Add a Space Object Custom Rectangle

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`svgImagePath`	string	name of path containing wallpaper object
`spaceObjectId`	string	Unique ID of the space object. NOTE!
`spaceObjectName`	string	Name of the space object.
`spaceObjectType`	string	Type of the object
`layer`	string	the associated layer of the object

Source:

cadviewer_pro_6_2_66.js, line 7454

cvjs_addRectangleSpaceObject(floorplan_div)

Add a Space Object Rectangle

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 23688

cvjs_addSelectedToOriginalStyles(rmid) → {boolean}

If an object has been selected, then add it to the list of Original Styles

Parameters:

Name	Type	Description
`rmid`	string	Id of the Space Object object to add hatches

Source:

cadviewer_pro_6_2_66.js, line 45262

Returns:

selected - true if selected, false otherwise

Type: boolean

cvjs_addSingleSpaceObject(floorplan_div, currentNode_name, currentNode_id, currentNode_layer, currentNode_group, currentNode_attributes, currentNode_attributeStatus, currentNode_type, currentNode_tags, currentNode_occupancy, currentNode_Path)

Directly sets a Space Object onto the canvas and increments the current array with space objects NOTE: User must take consideration to not define an ID already available.

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`currentNode_name`	string	name of the space object to be visualized at the modal header
`currentNode_id`	string	id of the object, used for pop-up highlight in "non-modal display" and for linking Space Objects with database entries
`currentNode_layer`	string	layer of the Space Object
`currentNode_group`	string	group of the Space Object
`currentNode_attributes`	string	a list of attributes for the Space Object
`currentNode_attributeStatus`	string	status of attributes list, can be populated or unpopulated, controls if data is pulled externally
`currentNode_type`	string	the type attribute of the Space Object, the type is displayed at the modal header
`currentNode_tags`	string	list of tags assocated with the object, for retrieval at custom developed highlight
`currentNode_occupancy`	string	tag to describe occupancy, for retrieval at custom developed highlight
`currentNode_Path`	string	The path of the Space Object as an SVG path

Source:

cadviewer_pro_6_2_66.js, line 43597

cvjs_addSpaceObjectDirectXY(floorplan_div, svgImagePath, spaceObjectId, spaceObjectName, spaceObjectType, coordinate_flag, xcor, ycor, textArray, scaleFactor, colorObject, textStyles, scaleText, hexColorText, leftFactor)

Add a Fixed Size Space Object Custom Rectangle at coordinates x, y

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`svgImagePath`	string	name of path containing wallpaper object
`spaceObjectId`	string	Unique ID of the space object. NOTE!
`spaceObjectName`	string	Name of the space object.
`spaceObjectType`	string	Type of the object
`coordinate_flag`	int	0 is SVG coordinates, 1 is DWG coordinates, 0 is default
`xcor`	int	x coordinate
`ycor`	int	y coordinate
`textArray`	Object	array with lines of text content in Space Object
`scaleFactor`	float	scale factor at insertion, 1.0 is default
`colorObject`	Object	object containing colors and style of default setting of Space Object, "none" provides standard default color
`textStyles`	Object	object containing colors and style of each line of text in the Space Object
`scaleText`	Array	array containing relative size af each line of text in the Space Object
`hexColorText`	Array	array containing color of each line of text in the Space Object
`leftFactor`	float	left adjustment factor of text in the Space Object

Source:

cadviewer_pro_6_2_66.js, line 32167

cvjs_addSVGClickHandler_onLoad(mode)

Set the clickhandler mode for SVG on load. The default is false
All SVG objects with an 'id' implemented will be associated with a clickhandler
The method will call a number of user implemented call-back methods:
cvjs_SVGfileObjectClicked(id, x, y) : callback for click on an object, this method is user implemented
cvjs_SVGfileObjectMouseEnter(id, x, y) : callback for mouse entering an object, this method is user implemented
cvjs_SVGfileObjectMouseLeave(id, x, y) : callback for mouse leaving an object, this method is user implemented
cvjs_SVGfileObjectMouseMove(id, x, y) : callback for mouse move on an object, this method is user implemented

Parameters:

Name	Type	Description
`mode`	boolean	true: click handlers are added to objects on load, false: no handers added on load

Source:

cadviewer_base_6_2_66.js, line 17444

cvjs_AddTextAndTBorderOnSpaceObject3Lines(txtLayer, nodeId, tborderId, leftScale, textId1, textString1, textStyle1, scaleText1, hexColorText1, textId2, textString2, textStyle2, scaleText2, hexColorText2, textId3, textString3, textStyle3, scaleText3, hexColorText3)

Add three lines of text, individually formatted and styled, inside a Space Object

Parameters:

Name	Type	Description
`txtLayer`	string	layer to apply the text
`nodeId`	string	nodeId of the graphical object in which to place the text
`tborderId`	string	Text Border Id of the new graphical object in which to place the text, of type "TBORDER_xxx"
`leftScale`	float	distance from the left border of Space Object, value between 0 and 1
`textId1`	string	Text Id of the first text object, of type "TEXT_xxx"
`textString1`	string	first line of text
`textStyle1`	object	textstyle of text line 1, formattet as a java script object with css style elements, predefined is: text_style_arial_11pt_bold , text_style_arial_9pt_normal, text_style_dialog
`scaleText1`	string	relative scale of text line 1, value between 0 and 1
`hexColorText1`	string	color of text line 1 in hex form, for example: #AA00AA
`textId2`	string	Text Id of the second text object, of type "TEXT_yyy"
`textString2`	string	second line of text
`textStyle2`	object	textstyle of text line 2, formattet as a java script object with css style elements
`scaleText2`	string	relative scale of text line 2, value between 0 and 1
`hexColorText2`	string	color of text line 2 in hex form, for example: #AA00AA
`textId3`	string	Text Id of the third text object, of type "TEXT_zzz"
`textString3`	string	third line of text
`textStyle3`	object	textstyle of text line 3, formattet as a java script object with css style elements
`scaleText3`	string	relative scale of text line 3, value between 0 and 1
`hexColorText3`	string	color of text line 3 in hex form, for example: #AA00AA

Source:

cadviewer_pro_6_2_66.js, line 2437

cvjs_AddTextAndTBorderOnSpaceObjectId(txtLayer, Id, leftScale, textStringArr, textStyleArr, scaleTextArr, hexColorTextArr, clipping, centering)

Add multiple of text, individually formatted and styled, inside a Space Object

Parameters:

Name	Type	Description
`txtLayer`	string	layer to apply the text
`Id`	string	Id of the graphical object in which to place the text
`leftScale`	float	distance from the left border of Space Object, value between 0 and 1
`textStringArr`	array	Array with the lines of text
`textStyleArr`	array	Array with textstyle of text lines, formattet as a java script object with css style elements, predefined is: text_style_arial_11pt_bold , text_style_arial_9pt_normal, text_style_dialog
`scaleTextArr`	array	Array with relative scale of text lines, value between 0 and 1
`hexColorTextArr`	array	Array of color of text lines in hex form, for example: #AA00AA
`clipping`	boolean	true if clipping of text inside of Space Object, false if text to cross Space Object borders
`centering`	boolean	true if centering of text inside of Space Object, false is default

Source:

cadviewer_pro_6_2_66.js, line 2653

cvjs_AddTextAndTBorderOnSpaceObjectId_GlobalHeight(txtLayer, Id, leftScale, textStringArr, textStyleArr, scaleTextArr, hexColorTextArr, clipping)

Add multiple of text, individually formatted and styled, inside a Space Object

Parameters:

Name	Type	Description
`txtLayer`	string	layer to apply the text
`Id`	string	Id of the graphical object in which to place the text
`leftScale`	float	distance from the left border of Space Object, value between 0 and 1
`textStringArr`	array	Array with the lines of text
`textStyleArr`	array	Array with textstyle of text lines, formattet as a java script object with css style elements, predefined is: text_style_arial_11pt_bold , text_style_arial_9pt_normal, text_style_dialog
`scaleTextArr`	array	Array with relative scale of text lines, value between 0 and 1, based on global height of drawing
`hexColorTextArr`	array	Array of color of text lines in hex form, for example: #AA00AA
`clipping`	boolean	true if clipping of text inside of Space Object, false if text to cross Space Object borders

Source:

cadviewer_pro_6_2_66.js, line 2610

cvjs_AddTextAndTBorderOnSpaceObjectNode(txtLayer, nodeId, leftScale, textStringArr, textStyleArr, scaleTextArr, hexColorTextArr, clipping, centering)

Add multiple of text, individually formatted and styled, inside a Space Object

Parameters:

Name	Type	Description
`txtLayer`	string	layer to apply the text
`nodeId`	string	nodeId of the graphical object in which to place the text
`leftScale`	float	distance from the left border of Space Object, value between 0 and 1
`textStringArr`	array	Array with the lines of text
`textStyleArr`	array	Array with textstyle of text lines, formattet as a java script object with css style elements, predefined is: text_style_arial_11pt_bold , text_style_arial_9pt_normal, text_style_dialog
`scaleTextArr`	array	Array with relative scale of text lines, value between 0 and 1
`hexColorTextArr`	array	Array of color of text lines in hex form, for example: #AA00AA
`clipping`	boolean	true if clipping of text inside of Space Object, false if text to cross Space Object borders
`centering`	boolean	true if centering of text inside of Space Object, false is default

Source:

cadviewer_pro_6_2_66.js, line 2694

cvjs_AddTextOnObject(txtLayer, nodeId, leftScale, textString1, textStyle1, scaleText1, hexColorText1, textString2, textStyle2, scaleText2, hexColorText2, textString3, textStyle3, scaleText3, hexColorText3)

Add three layers of text, individually formatted and styled, inside a Space Object

Parameters:

Name	Type	Description
`txtLayer`	string	layer to apply the text
`nodeId`	string	nodeId of the graphical object in which to place the text
`leftScale`	float	distance from the left border of Space Object, value between 0 and 1
`textString1`	string	first line of text
`textStyle1`	object	textstyle of text line 1, formattet as a java script object with css style elements, predefined is: text_style_arial_11pt_bold , text_style_arial_9pt_normal, text_style_dialog
`scaleText1`	string	relative scale of text line 1, value between 0 and 1
`hexColorText1`	string	color of text line 1 in hex form, for example: #AA00AA
`textString2`	string	second line of text
`textStyle2`	object	textstyle of text line 2, formattet as a java script object with css style elements
`scaleText2`	string	relative scale of text line 2, value between 0 and 1
`hexColorText2`	string	color of text line 2 in hex form, for example: #AA00AA
`textString3`	string	third line of text
`textStyle3`	object	textstyle of text line 3, formattet as a java script object with css style elements
`scaleText3`	string	relative scale of text line 3, value between 0 and 1
`hexColorText3`	string	color of text line 3 in hex form, for example: #AA00AA

Source:

cadviewer_pro_6_2_66.js, line 2328

cvjs_addUserIdToHiddenRedlineUsers(userId)

Add userId to list of redline and stickyNote users to be hidden (on load)

Parameters:

Name	Type	Description
`userId`	string	the userId to be added to the hidden users list

Source:

cadviewer_pro_6_2_66.js, line 3797

cvjs_addUserIdToLockedRedlineUsers(userId)

Add userId to list of redline and stickyNote users to be locked (on load)

Parameters:

Name	Type	Description
`userId`	string	the userId to be added to the hidden users list

Source:

cadviewer_pro_6_2_66.js, line 3813

cvjs_adjustMinimumLineThickness(precentage)

Adjust minimum line thickness

Parameters:

Name	Type	Description
`precentage`	int	In percentage, set the factor to adjust the minumum line thickness, a value over 100 makes lines thicker, a value below 100 makes lines thinner

Source:

cadviewer_base_6_2_66.js, line 12379

cvjs_ajaxPostCallbackVariable_thumbNails(callbackStatus)

Set the ajax control callback variable

Parameters:

Name	Type	Description
`callbackStatus`	boolean	set to false then monitor then true

Source:

cadviewer_pro_6_2_66.js, line 27622

cvjs_AllGroupsOff()

Turn all Object Space groups off - Object Spaces, Sticky Notes and Redlines are differentiated.

Source:

cadviewer_pro_6_2_66.js, line 1369

cvjs_AllGroupsOn()

Turn all Object Space groups on - Object Spaces, Sticky Notes and Redlines are differentiated.

Source:

cadviewer_pro_6_2_66.js, line 1352

cvjs_allLayersInDrawingOn(floorplan_div)

Sets all layers in drawing On

Parameters:

Name	Type	Description
`floorplan_div`	String	div of the CADViewerJS canvas

Source:

cadviewer_base_6_2_66.js, line 1495

cvjs_AllLayersOff()

Turn all Object Space layers off - Object Spaces, Sticky Notes and Redlines are differentiated.

Source:

cadviewer_base_6_2_66.js, line 8577

cvjs_allowFileLoadToServer(mode)

Enables file load through the icon interface, or allows it only through the encapsulating application

Parameters:

Name	Type	Description
`mode`	boolean	true for file load through File Manager, default is false

Source:

cadviewer_base_6_2_66.js, line 22568

cvjs_allSpaceObjectsOff(floorplan_div)

Turn all Space Object off

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div

Source:

cadviewer_pro_6_2_66.js, line 44135

cvjs_allSpaceObjectsOn(floorplan_div)

Turn all Space Objects on

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div

Source:

cadviewer_pro_6_2_66.js, line 44122

cvjs_ApplyPatternOnSpaceObjectId(layer, Id, graphicalPattern, colorHex, fillOpacity)

Apply a predefined pattern on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`Id`	string	Id of the graphical object to add hatches
`graphicalPattern`	string	name of the hatch pattern, from a predefined list of patterns: "pattern_45degree_standard" "pattern_45degree_fine" "pattern_45degree_wide" "pattern_90degree_standard" "pattern_90degree_fine" "pattern_90degree_wide" "pattern_135degree_standard" "pattern_135degree_fine" "pattern_135degree_wide" "pattern_0degree_standard" "pattern_0degree_fine" "pattern_0degree_wide" "pattern_45degree_crosshatch_standard" "pattern_45degree_crosshatch_fine"
`colorHex`	string	color of hatch in hex form, for example: #FF0000
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1474

cvjs_ApplyPatternOnSpaceObjectNode(layer, nodeId, graphicalPattern, colorHex, fillOpacity)

Apply a predefined pattern on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object to add hatches
`graphicalPattern`	string	name of the hatch pattern, from a predefined list of patterns: "pattern_45degree_standard" "pattern_45degree_fine" "pattern_45degree_wide" "pattern_90degree_standard" "pattern_90degree_fine" "pattern_90degree_wide" "pattern_135degree_standard" "pattern_135degree_fine" "pattern_135degree_wide" "pattern_0degree_standard" "pattern_0degree_fine" "pattern_0degree_wide" "pattern_45degree_crosshatch_standard" "pattern_45degree_crosshatch_fine"
`colorHex`	string	color of hatch in hex form, for example: #FF0000
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1508

cvjs_ApplyPatternOnUrl(layer, nodeId, graphicalPattern, colorHex, fillOpacity)

Apply a predefined pattern on a URL

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object to add hatches
`graphicalPattern`	string	name of the hatch pattern, from a predefined list of patterns: "pattern_45degree_standard" "pattern_45degree_fine" "pattern_45degree_wide" "pattern_90degree_standard" "pattern_90degree_fine" "pattern_90degree_wide" "pattern_135degree_standard" "pattern_135degree_fine" "pattern_135degree_wide" "pattern_0degree_standard" "pattern_0degree_fine" "pattern_0degree_wide" "pattern_45degree_crosshatch_standard" "pattern_45degree_crosshatch_fine"
`colorHex`	string	color of hatch in hex form, for example: #FF0000
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1542

cvjs_ApplyRelativeLinearGradientOnObject_layerSort(layer, nodeId, xStart, yStart, xEnd, yEnd, startColor, middleColor, endColor, fillOpacity, layer2)

Apply a linear gradient, with definition of gradient vector, with three colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object
`xStart`	float	gradient vector x start point, value between 0 and 1
`yStart`	float	gradient vector y start point, value between 0 and 1
`xEnd`	float	gradient vector x end point, value between 0 and 1
`yEnd`	float	gradient vector y end point, value between 0 and 1
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`middleColor`	string	middle color of gradient in hex form, for example: #AA00AA
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1
`layer2`	string	layer which to prepend the gradient layer (typically the main Space Object layer)

Source:

cadviewer_pro_6_2_66.js, line 1976

cvjs_ApplyRelativeLinearGradientStandard2ColorsOnSpaceObjectId(layer, Id, startColor, endColor, fillOpacity)

Apply a standard linear gradient with two colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`Id`	string	Id of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1903

cvjs_ApplyRelativeLinearGradientStandard2ColorsOnSpaceObjectNode(layer, nodeId, startColor, endColor, fillOpacity)

Apply a standard linear gradient with two colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1919

cvjs_ApplyRelativeLinearGradientStandard3ColorsOnSpaceObjectId(layer, Id, startColor, middleColor, endColor, fillOpacity)

Apply a standard linear gradient with three colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`Id`	string	Id of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`middleColor`	string	middle color of gradient in hex form, for example: #AA00AA
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1937

cvjs_ApplyRelativeLinearGradientStandard3ColorsOnSpaceObjectNode(layer, nodeId, startColor, middleColor, endColor, fillOpacity)

Apply a standard linear gradient with three colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`middleColor`	string	middle color of gradient in hex form, for example: #AA00AA
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 1955

cvjs_ApplyRelativeRadialGradientOnObject_layerSort(layer, nodeId, xC, yC, radius, startColor, middleColor, endColor, fillOpacity, layer2)

Apply a radial gradient, with definition of gradient vector, with three colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object
`xC`	float	gradient vector x start point, value between 0 and 1
`yC`	float	gradient vector y start point, value between 0 and 1
`radius`	float	gradient vector radius, value between 0 and 1
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`middleColor`	string	middle color of gradient in hex form, for example: #AA00AA
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1
`layer2`	string	layer which to prepend the gradient layer (typically the main Space Object layer)

Source:

cadviewer_pro_6_2_66.js, line 2172

cvjs_ApplyRelativeRadialGradientStandard2ColorsOnSpaceObjectId(layer, Id, startColor, endColor, fillOpacity)

Apply a standard radial gradient with two colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`Id`	string	Id of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 2095

cvjs_ApplyRelativeRadialGradientStandard2ColorsOnSpaceObjectNode(layer, nodeId, startColor, endColor, fillOpacity)

Apply a standard radial gradient with two colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 2113

cvjs_ApplyRelativeRadialGradientStandard3ColorsOnSpaceObjectId(layer, Id, startColor, middleColor, endColor, fillOpacity)

Apply a standard radial gradient with three colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`Id`	string	Id of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`middleColor`	string	middle color of gradient in hex form, for example: #AA00AA
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 2130

cvjs_ApplyRelativeRadialGradientStandard3ColorsOnSpaceObjectNode(layer, nodeId, startColor, middleColor, endColor, fillOpacity)

Apply a standard radial gradient with three colors on a graphical Space Object

Parameters:

Name	Type	Description
`layer`	string	layer to apply the pattern
`nodeId`	string	nodeId of the graphical object
`startColor`	string	start color of gradient in hex form, for example: #FF0000
`middleColor`	string	middle color of gradient in hex form, for example: #AA00AA
`endColor`	string	end color of gradient in hex form, for example: #00DD00
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 2149

cvjs_batchConvertDrawingsToPDF(drawingFilesArray, pageOrientationArray, pageSizeArray, pageResolutionArray)

Loads a set of drawings, apply page size, page orientation and resolution to each page/drawing. Produce a multi-page PDF out of the set of drawing.

Parameters:

Name	Type	Description
`drawingFilesArray`	Array.<string>	String array with name and location of drawings
`pageOrientationArray`	Array.<string>	String array with orientation of drawings: landscape/portrait
`pageSizeArray`	Array.<string>	String array with papersizes of drawings
`pageResolutionArray`	Array.<string>	Array with page resolutions

Source:

cadviewer_pro_6_2_66.js, line 38622

cvjs_batchConvertDrawingsToPDF_CustomReport(string, drawingFilesArray, pageOrientationArray, pageSizeArray, pageResolutionArray, string, Object)

Loads a set of drawings, apply page size, page orientation and resolution to each page/drawing. Produce a multi-page PDF out of the set of drawing.

Parameters:

Name	Type	Description
`string`		floorPlan - Name of the floorplan div for batch processing
`drawingFilesArray`	Array.<string>	String array with name and location of drawings
`pageOrientationArray`	Array.<string>	String array with orientation of drawings: landscape/portrait
`pageSizeArray`	Array.<string>	String array with papersizes of drawings
`pageResolutionArray`	Array.<string>	Array with page resolutions
`string`		batchFilesToPDF_Controller - Name of the php document that creates the report when the graphics is created
`Object`		callbackMethod - callBackMethod to decorate each drawing before publishing

Source:

cadviewer_base_6_2_66.js, line 3322

cvjs_buildFolderTree(FileLocation, DocumentLocation, floorplan_div)

Build a tree structure in which to be able to load CADViewer dynamically

Parameters:

Name	Type	Description
`FileLocation`	string	location of file tree folder
`DocumentLocation`	string	location of current document
`floorplan_div`	string	name of the Element in which CADViewer is running

Source:

cadviewer_pro_6_2_66.js, line 29374

cvjs_buildMultiPageSVG(directory, url_directory)

Build an internal navigational structure over a folder with SVG files named sequentially xx_1.svg, xx_2.svg....

Parameters:

Name	Type	Description
`directory`	string	server side name of the folder in which the svg files are placed. The folder should only contain the svg files to navigate over
`url_directory`	string	url of the folder in which the svg files are placed.

Source:

cadviewer_base_6_2_66.js, line 22664

cvjs_CADViewerPro(cadviewerpro)

Changes CADViewer from CADViewer Community to CADViewer Pro

Parameters:

Name	Type	Description
`cadviewerpro`	boolean	true for CADViewer Pro, false for CADViewer Community

Source:

cadviewer_pro_6_2_66.js, line 37232

cvjs_calibrateMeasurement(floorplan_div)

Calibrate measurement

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_base_6_2_66.js, line 2220

cvjs_changePageByNumber(floorplan_div, newpagenumber) → {boolean}

Change page on the current drawing based on page number

Parameters:

Name	Type	Description
`floorplan_div`	string	name of Element on which CADViewer is located
`newpagenumber`	int	a number between 1 and the total pages in the drawing

Source:

cadviewer_base_6_2_66.js, line 8184

Returns:

status - false if newpagenumber outside of range, true if page change

Type: boolean

cvjs_changeSpaceObjectDisplayMode(floorplan_div)

Sets the mode of Space Object to either display or create

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 24279

cvjs_changeSpaceObjectID(currentId, newId) → {boolean}

Change the ID of a current Space Object

Parameters:

Name	Type	Description
`currentId`	string	The current ID of the Space Object
`newId`	String	The new ID of the Space Object

Source:

cadviewer_pro_6_2_66.js, line 44672

Returns:

flag - true if changed, otherwise false. Note, it cannot be changed into an existing ID

Type: boolean

cvjs_changeSpaceObjectLayer(currentId, newLayer) → {boolean}

Change the layer of a current Space Object

Parameters:

Name	Type	Description
`currentId`	string	The current ID of the Space Object
`newLayer`	string	The new layer of the Space Object

Source:

cadviewer_pro_6_2_66.js, line 44534

Returns:

flag - true if changed, otherwise false

Type: boolean

cvjs_changeSpaceObjectLinkStatus(currentId, linkFlag) → {boolean}

Set the link status Space Object

Parameters:

Name	Type	Description
`currentId`	string	The current ID of the Space Object
`linkFlag`	boolean	The new link Status of the Space Object

Source:

cadviewer_pro_6_2_66.js, line 44556

Returns:

flag - true if changed, otherwise false

Type: boolean

cvjs_changeSpaceObjectName(currentId, newName) → {boolean}

Change the Name of a current Space Object

Parameters:

Name	Type	Description
`currentId`	string	The current ID of the Space Object
`newName`	string	The new Name of the Space Object

Source:

cadviewer_pro_6_2_66.js, line 44580

Returns:

flag - true if changed, otherwise false

Type: boolean

cvjs_changeSpaceObjectType(currentId, newType) → {boolean}

Change the Space Type of a current Space Object

Parameters:

Name	Type	Description
`currentId`	string	The current ID of the Space Object
`newType`	string	The new Type of the Space Object

Source:

cadviewer_pro_6_2_66.js, line 44626

Returns:

flag - true if changed, otherwise false

Type: boolean

cvjs_changeText_On_BlockHandle(handle, textArr)

Changes visible text attribute objects on a block, referenced through its block handle

Parameters:

Name	Type	Description
`handle`	string	AutoCAD block handle referecen
`textArr`	Array.<string>	Array with the text objects to be replaced. The lenght of the array determines how many objects are replaced

Source:

cadviewer_pro_6_2_66.js, line 16998

cvjs_changeText_On_BlockHandleDiv(handle, textArr, floorplan_div) → {boolean}

Changes visible text attribute objects on a block, referenced through its block handle

Parameters:

Name	Type	Description
`handle`	string	AutoCAD block handle reference
`textArr`	Array.<string>	Array with the text objects to be replaced. The lenght of the array determines how many objects are replaced
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 17066

Returns:

false if handle not found otherwise true

Type: boolean

cvjs_checkBlockHandleDiv(handle, floorplan_div) → {boolean}

Checks if a block handle is present on the floorplan

Parameters:

Name	Type	Description
`handle`	string	AutoCAD block handle reference
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 17835

Returns:

false if handle not found otherwise true

Type: boolean

cvjs_checkRoomHandleDiv(rmid, floorplan_div) → {boolean}

Checks if a RoomID is present on a given floorplan

Parameters:

Name	Type	Description
`rmid`	string	Id of the Space Object to highlight
`floorplan_div`	string	name of the div on which the CADViewerJS instance is placed

Source:

cadviewer_pro_6_2_66.js, line 17809

Returns:

false if rmid not found otherwise true

Type: boolean

cvjs_clear_collab_redline(floorplan_div)

Clear the redlines in collaboration session

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 15995

cvjs_clearAllCustomTooltips()

Clears all custom tooltips

Source:

cadviewer_pro_6_2_66.js, line 45182

cvjs_clearAllHighlightSpaceObjectDirect(floorplan_div)

Clear all Highlight on all Space Objects and returns to default settings

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div

Source:

cadviewer_pro_6_2_66.js, line 43720

cvjs_clearAllImageLinks(floorplan_div)

Clears all image links from the canvas

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 23405

cvjs_clearAllRedlineHiddenUsers()

Clear all redline and stickyNote userId from hidden users list

Source:

cadviewer_pro_6_2_66.js, line 3828

cvjs_clearAllRedlineLockedUsers()

Clear all redline and stickyNote userId from locked users list

Source:

cadviewer_pro_6_2_66.js, line 3838

cvjs_clearCurrentRedline(floorplan_div)

Clear all redlines currently visible

Parameters:

Name	Type	Description
`floorplan_div`	String	div of the CADViewerJS canvas

Source:

cadviewer_base_6_2_66.js, line 15557

cvjs_ClearDrawing(floorplan_div)

Clears the drawing space of CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the div canvas object to which CADViewer is allocated

Source:

cadviewer_base_6_2_66.js, line 14155

cvjs_clearDrawingHyperlinks()

Clears the drawing from any highlight or modals active on Hyperlinks

Source:

cadviewer_pro_6_2_66.js, line 38942

cvjs_clearDrawingRedlines()

Clears the drawing from any redlines

Source:

cadviewer_pro_6_2_66.js, line 38981

cvjs_clearDrawingSpaceObjects()

Clears the drawing from any highlight or modals active on Space Objects

Source:

cadviewer_pro_6_2_66.js, line 38818

cvjs_clearDrawingStickyNotes()

Clears the drawing from any highlight or modals active on StickyNotes

Source:

cadviewer_pro_6_2_66.js, line 38882

cvjs_clearHighlightSpaceObjectDirect(floorplan_div, objectID)

Clear the Highlight a Space Object and returns to default settings

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`objectID`	string	id of the object, used for pop-up highlight in "non-modal display" and for linking Space Objects with database entries

Source:

cadviewer_pro_6_2_66.js, line 43707

cvjs_clearLayer(layer) → {none}

Clears the current layer

Parameters:

Name	Type	Description
`layer`	string	name of layer to be cleared

Source:

cadviewer_pro_6_2_66.js, line 1194

Returns:

Type: none

cvjs_clearLayerDiv(layer, floorplan_div) → {none}

Clears the current layer on a named floorplan div

Parameters:

Name	Type	Description
`layer`	string	name of layer to be cleared
`floorplan_div`	string	name of floorplan div

Source:

cadviewer_pro_6_2_66.js, line 1224

Returns:

Type: none

cvjs_clearQuickCounts(floorplan_div)

Clear the quick counts counter

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 13721

cvjs_clearSpaceLayer() → {none}

Clears and initialize the general Space Layer for highlights

Source:

cadviewer_pro_6_2_66.js, line 44972

Returns:

Type: none

cvjs_clearTextLayer(layer) → {none}

Clears the current layer and resets Text border objects

Parameters:

Name	Type	Description
`layer`	string	name of layer to be cleared

Source:

cadviewer_pro_6_2_66.js, line 1255

Returns:

Type: none

cvjs_click(id, handle, entity)

Callback method from CADViewer when an AutoCAD handle object has been clicked

Parameters:

Name	Type	Description
`id`	String	the ID of the object, this ID can be used to reference the object using jQuery
`handle`	String	the AutoCAD handle of the object, this is an unique ID for each geometrical unit in the drawing,
`entity`	String	the entity associated with the Handle, including the AutoCAD AcDb prefix to entities

Source:

cadviewer_pro_6_2_66.js, line 45379

cvjs_colorAllLayersInDrawing(floorplan-div, hexColor)

Toggle the color settings Black /White

Parameters:

Name	Type	Description
`floorplan-div`	string	the ID of the Element in which CADViewer is running
`hexColor`	string	color of all layers

Source:

cadviewer_pro_6_2_66.js, line 22751

cvjs_colorSingleSVGHyperlink(hyperlinkId, hyperFill, hyperOpacity)

Add color to an xlink SVG hyperlinks to have it behave like a dynamic highlight

Parameters:

Name	Type	Description
`hyperlinkId`	string	the element of the xlink hyperlink
`hyperFill`	string	the new fill color, of type #00FF00
`hyperOpacity`	float	the opacity of the fill, a value between 0.0 and 1.0.

Source:

cadviewer_pro_6_2_66.js, line 16793

cvjs_compareDrawings_LoadSecondDrawing(floorplan_div)

Loads the second drawing for compare with drawing currently loaded

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 15372

cvjs_compareDrawings_ToggleDrawingOverlay(floorplan_div)

Toggles the overlaid drawings

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 15520

cvjs_compareDrawings_ToggleDrawings(floorplan_div)

Toggles the drawings individually

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 15616

cvjs_CompareFiles_setFileModalContent(custom_modal_dir_listing, floorPlan_div)

Sets the direct content of the file load modal instead of scanning through a designated folder

Parameters:

Name	Type	Description
`custom_modal_dir_listing`	object	a structure containing filename, url, and path
`floorPlan_div`	String	name of the div that contains the floorplan

Source:

cadviewer_pro_6_2_66.js, line 31327

cvjs_connectTextInstances(searchString1, textInstance1, searchString1, textInstance1, lengthfactor1, lengthfactor2)

Connect Text Strings; connects two text strings with a line and arrow

Parameters:

Name	Type	Description
`searchString1`	string	the first text string to search after
`textInstance1`	int	if multiple entries of text object, load instance, the first instance is 1
`searchString1`	string	the second text string to search after
`textInstance1`	int	if multiple entries of text object, load instance, the first instance is 1
`lengthfactor1`	int	% value, tells how many percentages line should be shorted at first text
`lengthfactor2`	int	% value, tells how many percentages line should be shorted at end text

Source:

cadviewer_pro_6_2_66.js, line 29666

cvjs_conversion_addAXconversionParameter(name, value-, floorplan_div)

Add an AutoXchange conversion control parameter for server based conversion

Parameters:

Name	Type	Description
`name`	string	conversion parameter name
`value-`	string	conversion parameter value, if no value set ""
`floorplan_div`	string	name of the div on which the floorplan is places

Source:

cadviewer_base_6_2_66.js, line 15990

cvjs_conversion_cleanFilesDirectory()

Clean the server side temporary folder for files. This command is useful when using cvjs_conversion_setContentResponse("file"); where the server conversion provides a full set of files that is not removed when read by CADViewer

Source:

cadviewer_pro_6_2_66.js, line 23526

cvjs_conversion_clearAXconversionParameters(floorplan_div)

Clears the custom AutoXchange conversion control parameter for server based conversion

Parameters:

Name	Type	Description
`floorplan_div`	string	name of the div on which the floorplan is places

Source:

cadviewer_base_6_2_66.js, line 15959

cvjs_Conversion_forPrint(floorplan_div, originatingContent, originatingUsername, originatingPassword, fileFormat)

Conversion for Print , either SVG or PDF with JSON handling.

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`originatingContent`	string	base file name
`originatingUsername`	string	username or ""
`originatingPassword`	string	password or ""
`fileFormat`	string	"pdf" or "svg"

Source:

cadviewer_base_6_2_66.js, line 3885

cvjs_conversion_getContentResponse()

Get the current type of content response

Source:

cadviewer_base_6_2_66.js, line 16089

Returns:

string - Returns type of content response - "file | embedded | stream"

cvjs_conversion_setApplicationServiceParameters(applicationPlatform, applicationPlatformUsername, applicationPlatformUserID, ServiceToken, leaveStreamOnServerOnServer)

Sets control parameter for service conversion

Parameters:

Name	Type	Description
`applicationPlatform`	string	-
`applicationPlatformUsername`	string
`applicationPlatformUserID`	string
`ServiceToken`	string
`leaveStreamOnServerOnServer`	int

Source:

cadviewer_pro_6_2_66.js, line 29514

cvjs_conversion_setContentFormat(contentFormat)

Sets control parameter for conversion

Parameters:

Name	Type	Description
`contentFormat`	string	"DWG \| DXF\| DWF \| DGN - DGN currently not implemented",

Source:

cadviewer_base_6_2_66.js, line 16030

cvjs_conversion_setContentResponse(userLabel)

Sets control parameter for conversion

Parameters:

Name	Type	Description
`userLabel`	string	" optional label returned in the response",,

Source:

cadviewer_base_6_2_66.js, line 16077

cvjs_conversion_setContentType(contentType)

Sets control parameter for conversion

Parameters:

Name	Type	Description
`contentType`	string	"file \| embedded \| stream"

Source:

cadviewer_base_6_2_66.js, line 16017

cvjs_conversion_setUserLabel(userLabel)

Sets control parameter for conversion

Parameters:

Name	Type	Description
`userLabel`	string	" optional label returned in the response",,

Source:

cadviewer_base_6_2_66.js, line 16066

cvjs_copyCircleSpaceObject(floorplan_div)

Copy a Space Object Circle

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 23964

cvjs_copyMeasurementField(floorplan_div)

Copies the content of the measurement field to the clipboard

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_base_6_2_66.js, line 26034

cvjs_currentHost() → {string}

Finds the current host of the library

Source:

cadviewer_base_6_2_66.js, line 1611

Returns:

host - current hostlocation

Type: string

cvjs_currentMaxNodeId() → {string}

Retrieves the current maximum Node Id for all Space Objects, retrieve and increment when creating new graphical objects

Deprecated:

Yes

Source:

cadviewer_pro_6_2_66.js, line 3756

Returns:

maxNode - the current maximum node id

Type: string

cvjs_currentMaxSpaceNodeId() → {string}

Retrieves the current maximum Node Id for all Space Objects, retrieve and increment when creating new graphical objects

Source:

cadviewer_pro_6_2_66.js, line 3776

Returns:

maxNode - the current maximum node id

Type: string

cvjs_currentURL() → {string}

Finds the current url of the library

Source:

cadviewer_base_6_2_66.js, line 1599

Returns:

url - current location

Type: string

cvjs_dblclick(id, handle, entity)

Callback method from CADViewer when an AutoCAD handle object has been double clicked

Parameters:

Name	Type	Description
`id`	String	the ID of the object, this ID can be used to reference the object using jQuery
`handle`	String	the AutoCAD handle of the object, this is an unique ID for each geometrical unit in the drawing,
`entity`	String	the entity associated with the Handle, including the AutoCAD AcDb prefix to entities

Source:

cadviewer_pro_6_2_66.js, line 45393

cvjs_debugMode(debug)

Sets debug mode

Parameters:

Name	Type	Description
`debug`	boolean	true for debug traces, false otherwise

Source:

cadviewer_base_6_2_66.js, line 16103

cvjs_deleteLastRedline(floorplan_div)

Deletes the last drawn Redline

Parameters:

Name	Type	Description
`floorplan_div`	String	div of the CADViewerJS canvas

Source:

cadviewer_pro_6_2_66.js, line 38000

cvjs_deleteSingleRedline(floorplan_div)

Deletes a single redline

Parameters:

Name	Type	Description
`floorplan_div`	String	div of the CADViewerJS canvas

Source:

cadviewer_pro_6_2_66.js, line 38539

cvjs_deleteSpaceImageObject(floorplan_div)

Delete a Space Image Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 32966

cvjs_deleteSpaceObject(floorplan_div)

Delete a Space Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 24025

cvjs_deleteSpaceObjectDirectXY(floorplan_div, objectID) → {boolean}

Delete Space Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`objectID`	string	id of the object, used for pop-up highlight in "non-modal display" and for linking Space Objects with database entries

Source:

cadviewer_pro_6_2_66.js, line 44098

Returns:

flag - true if deleted, false if objectID undefined

Type: boolean

cvjs_directDownloadStickyNotesRedlines(floorplan_div, filename)

Trigger a direct download of the current redline on canvas into a file for local save

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`filename`	string	name of redline file of screen content to download, it's format extension must be .js

Source:

cadviewer_pro_6_2_66.js, line 43344

cvjs_directUploadStickyNotesRedlines(floorplan_div)

Trigger a direct local source load of a redline file into the current canvas

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div

Source:

cadviewer_pro_6_2_66.js, line 43375

cvjs_DisablePrintIcon(floorplan_div)

Disables print Icon

Parameters:

Name	Type	Description
`floorplan_div`	String	name of Element in which CADViewer is running

Source:

cadviewer_base_6_2_66.js, line 722

cvjs_displayAllInterfaceControls(mode, floorplan_div)

Removes all icon interface components for viewing, redlining, etc. so that developers can control their own interface

Parameters:

Name	Type	Description
`mode`	boolean	Set the modal interface, default is true
`floorplan_div`	String	the div running CADViewer

Source:

cadviewer_base_6_2_66.js, line 12769

cvjs_displayAllInterfaceControlsZoomDisk(floorplan_div)

Show the zoom disk

Parameters:

Name	Type	Description
`floorplan_div`	String	the div running CADViewer

Source:

cadviewer_base_6_2_66.js, line 12701

cvjs_displayCustomToolTip(id)

Set a custom tooltip overwriting the standard tooltip displaying either Name or Id

Parameters:

Name	Type	Description
`id`	string	id of the custom tooltip object to be displayed

Source:

cadviewer_pro_6_2_66.js, line 710

cvjs_displayInformationModal(floorplan_div, text, modalHeight, modal_left,, modal_top,)

Activates and displays the information modal with text

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas
`text`	String	string to display
`modalHeight`	int	of modal, omit if using standard values
`modal_left,`	int	position of modal
`modal_top,`	int	position of modal

Source:

cadviewer_base_6_2_66.js, line 1662

cvjs_displaySpaceObjectsStructure(floorplan_div)

Display of Space Object structure in User Mode, with enabled seach panel

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 24491

cvjs_displayTopMenuIconBar(display_status, floorplan_div)

Controls top menu icon bar visibility

Parameters:

Name	Type	Description
`display_status`	boolean	default is true, use false to hide menu bar
`floorplan_div`	String	div in which CADViewer is implemented

Source:

cadviewer_base_6_2_66.js, line 21817

cvjs_displayTopNavigationBar(display_status, floorplan_div)

Controls top menu navigation bar visibility

Parameters:

Name	Type	Description
`display_status`	boolean	default is true, use false to hide menu bar
`floorplan_div`	String	div in which CADViewer is implemented

Source:

cadviewer_base_6_2_66.js, line 21845

cvjs_dragBackgroundToBack_SVG(floorplan_div)

Sends the dragging background to back - default

Parameters:

Name	Type	Description
`floorplan_div`	string	name of Element on which CADViewer is located

Source:

cadviewer_pro_6_2_66.js, line 27861

cvjs_dragBackgroundToFront_SVG(floorplan_div)

Brings the dragging background to front - used for drawings with static filled polygons

Parameters:

Name	Type	Description
`floorplan_div`	string	name of Element on which CADViewer is located

Source:

cadviewer_pro_6_2_66.js, line 27852

cvjs_drawRedline__Freehand()

Draws interactively a freehand redline. The data object of the redline is defined as a Redline. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 37248

cvjs_drawRedline_Freehand(floorplan_div)

Draws a freehand redline - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37882

cvjs_drawRedline_Freehand_globalColorWidth()

Draws a freehand redline - uses global values of color and width

Source:

cadviewer_pro_6_2_66.js, line 37916

cvjs_drawRedlineArrow(floorplan_div)

Draws a redline polyline with arrow - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37738

cvjs_drawRedlineCloud(floorplan_div)

Draws a redline cloud - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37663

cvjs_drawRedlineFilledPolygon(floorplan_div)

Draws a redline filled polygon - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37714

cvjs_drawRedlineFilledRectangle(floorplan_div)

Draws a redline filled rectangle - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37639

cvjs_drawRedlinePolyline(floorplan_div)

Draws a redline polyline - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37689

cvjs_drawRedlineRectangle(floorplan_div)

Draws a redline rectangle - uses global settings of color and width

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37615

cvjs_drawRedlineText(floorplan_div)

Draws a redline text - uses global settings of color

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37766

cvjs_drawSpaceObject_Circle()

Draws interactively a circle. The data object of the circle is defined as a Space Object. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7156

cvjs_drawSpaceObject_CopyCircle()

Draws interactively a copy of a previously defined cicle object. The data object of the circle is defined as a SpaceObject. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 10130

cvjs_drawSpaceObject_CustomRectangle()

Draws interactively a rectangle and add a custom wallpaper. The data object of the rectangle is defined as a Space Object. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7496

cvjs_drawSpaceObject_FilledRedlineRectangle()

Draws interactively a filled redline rectangle. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 8242

cvjs_drawSpaceObject_FixedSize()

Draws a fixed size space and add a custom wallpaper. The data object of the rectangle is defined as a Space Object. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 32422

cvjs_drawSpaceObject_PinMarker()

Interactively draws a custom wallpaper. The data object of the rectangle is defined as a Space Object. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 30535

cvjs_drawSpaceObject_Polygon()

Draws interactively a polygon. The data object of the polygon is defined as a Space Object. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 9019

cvjs_drawSpaceObject_Rectangle()

Draws interactively a rectangle. The data object of the rectangle is defined as a Space Object. Prior to calling this method, cvjs_setCurrentSpaceObjectNodeValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7698

cvjs_drawSpaceObject_RedlineArrowPolyline()

Draws interactively a redline polyline with arrow. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 9400

cvjs_drawSpaceObject_RedlineCloud()

Draws interactively a cloud. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7273

cvjs_drawSpaceObject_RedlineEllipse()

Draws interactively a Redline Ellipse . Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7964

cvjs_drawSpaceObject_RedlineEllipseCloud()

Draws interactively a Redline Ellipse Cloud . Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7955

cvjs_drawSpaceObject_RedlineFilledPolygon()

Draws interactively a redline polygon. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 9656

cvjs_drawSpaceObject_RedlinePolyline()

Draws interactively a redline polyline. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 9209

cvjs_drawSpaceObject_RedlineRectangle()

Draws interactively a redline rectangle. Prior to calling this method, cvjs_setCurrentRedlineValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 7828

cvjs_drawStickyNote(floorplan_div)

Draws a freehand stickynote - uses global settings of user and user id

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 37958

cvjs_drawStickyNoteDirect()

Draws interactively a stickynote. The data object of the sticky note is defined as a StickyNote. Prior to calling this method, cvjs_setCurrentStickyNoteValues() should be called.

Source:

cadviewer_pro_6_2_66.js, line 10223

cvjs_dynamicResizeTextOnSpaceObject(nodeUnderbar)

Dynamic resize and change location of text objects drawn on Space Object

Parameters:

Name	Type	Description
`nodeUnderbar`	string	the data node containing the Space Object to which the text is associated

Source:

cadviewer_pro_6_2_66.js, line 8628

cvjs_dynamicResizeTextOnSpaceObject_Id(id)

Dynamic resize and change location of text objects drawn on Space Object

Parameters:

Name	Type	Description
`id`	string	the id of the data node containing the Space Object to which the text is associated

Source:

cadviewer_pro_6_2_66.js, line 8660

cvjs_dynamicResizeTextOnSpaceObject_Name(name)

Dynamic resize and change location of text objects drawn on Space Object

Parameters:

Name	Type	Description
`name`	string	the name of the data node containing the Space Object to which the text is associated

Source:

cadviewer_pro_6_2_66.js, line 8640

cvjs_emailScreenAsPDFwithRedlines(floorplan_div)

Saves a floorplan with overlays as SVG file, then embed it into a pdf and send it as email

Parameters:

Name	Type	Description
`floorplan_div`	string	name of Element on which CADViewer is located

Source:

cadviewer_pro_6_2_66.js, line 27674

cvjs_emailSettings_PDF_publish(from_name, from_mail, cc_mail, replyto)

Settings for email sender in the PDF publish method. When calling this method, email will be activated

Parameters:

Name	Type	Description
`from_name`	string	name of the from sender in redline PDF email
`from_mail`	string	email address of the from sender in redline PDF email
`cc_mail`	string	email of the cc address when sending redline PDF email
`replyto`	string	mail of the reply to sender in redline PDF email

Source:

cadviewer_pro_6_2_66.js, line 27654

cvjs_EnablePrintIcon(floorplan_div)

Enables print Icon

Parameters:

Name	Type	Description
`floorplan_div`	String	name of Element in which CADViewer is running

Source:

cadviewer_base_6_2_66.js, line 694

cvjs_encapsulateUrl_callback(true:)

Encapsulate Url in JavaScript callback method cvjs_Url_callback(). Developer gets control over all hyperlinks in drawing

Parameters:

Name	Type	Description
`true:`	boolean	enable callback method false: disable callback method (link directly from drawing)

Source:

cadviewer_base_6_2_66.js, line 8567

cvjs_encodeURIcallToserver(flag)

Sets flag to control if call to server php for conversion shall be URI encoded or not. Default is true.

Parameters:

Name	Type	Description
`flag`	boolean	default is true. Set to true to custom implement this feature

Source:

cadviewer_base_6_2_66.js, line 751

cvjs_exitCompareDrawings(floorplan_div)

Exit compare drawing and returns to base drawing

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 15701

cvjs_exitMultiSelect()

Exit multi-select

Source:

cadviewer_pro_6_2_66.js, line 45348

cvjs_exitQuickCount(floorplan_div)

Exit quick count, alternative method to double click or Esc

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_pro_6_2_66.js, line 13888

cvjs_fileLoad_setContentFormat(fileFormat)

Sets fileformat for file-load

Parameters:

Name	Type	Description
`fileFormat`	string	"PNG, JPG, GIF", to set bitmap, "JS" for standard load

Source:

cadviewer_base_6_2_66.js, line 16043

cvjs_fileLoadFromSharePointServer(mode)

Sets file loading so that it done from a SharePoint Server

Parameters:

Name	Type	Description
`mode`	boolean	true to load files from sharepoint server, file names are then loaded through internal sharepoint REST calls, false is default standard server load of draiwngs

Source:

cadviewer_base_6_2_66.js, line 613

cvjs_generateShareFileDrawingList()

Calls server side PHP controller to fetch file list from Sharepoint server. A CAD server tree is built for jstree file selector.

Source:

cadviewer_pro_6_2_66.js, line 41962

cvjs_getAllRedlines_TextList() → {String}

Generate list with all redline text and their corresponding userId

Source:

cadviewer_pro_6_2_66.js, line 3938

Returns:

value - Returns Id, redline text list; (userid,redlinetext);(userid,redlinetext)

Type: String

cvjs_getAllRedlines_UserIdList() → {String}

Generate list with all redlines users

Source:

cadviewer_pro_6_2_66.js, line 3876

Returns:

value - Returns Id list, separated by ;

Type: String

cvjs_getAttributeFromSpaceObjectNode(NodeId, name) → {object}

Retrieves an attribute value from a Space Object

Parameters:

Name	Type	Description
`NodeId`	string	Node id of the Space Object in which to retrive an attribute
`name`	string	name of attribute (name, value) pair

Source:

cadviewer_pro_6_2_66.js, line 1050

Returns:

value - Returns the value pair corresponding to the given name

Type: object

cvjs_getAttributeStatus(NodeId) → {object}

Retrieves the attribute status from a Space Object

Parameters:

Name	Type	Description
`NodeId`	string	Node id of the Space Object in which to retrive the status

Source:

cadviewer_pro_6_2_66.js, line 1000

Returns:

value - Returns the attributeStatus

Type: object

cvjs_getCurrentMeasurementUnit() → {string}

Returns the setting of Measurement Units on the current drawing/page from the active floorplan_div

Source:

cadviewer_pro_6_2_66.js, line 29082

Returns:

units - Measurement Unit (mmn, cm, m, feet, inch)

Type: string

cvjs_getCurrentMultiPage_FileName() → {string}

Returns the current fileName from the MultiPages list

Source:

cadviewer_base_6_2_66.js, line 1587

Returns:

url - current location

Type: string

cvjs_getCurrentPage() → {int}

Returns the current page number in the document loaded

Source:

cadviewer_base_6_2_66.js, line 13820

Returns:

pageNumber

Type: int

cvjs_getLanguages() → {string}

Get the languages supported in CADViewer

Source:

cadviewer_base_6_2_66.js, line 21655

Returns:

languages - string with available languages

Type: string

cvjs_getLayerForSpaceObject(floorplan_div, ObjectID) → {string}

Get the associated layer name for the Space Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`ObjectID`	String	Space Object Id on layer, -1 if none found

Source:

cadviewer_pro_6_2_66.js, line 44173

Returns:

layerName - name of the layer field of the Space Object

Type: string

cvjs_getRedlineHiddenUsersList() → {String}

Lists all redline and stickyNote userId from hidden users list

Source:

cadviewer_pro_6_2_66.js, line 3850

Returns:

value - Returns Id list

Type: String

cvjs_getRedlineLockedUsersList() → {String}

Lists all redline and stickyNote userId from locked users list

Source:

cadviewer_pro_6_2_66.js, line 3861

Returns:

value - Returns Id list

Type: String

cvjs_getServerBackEndUrl() → {string}

Get the current ServerBackEndUrl variable;

Source:

cadviewer_base_6_2_66.js, line 21716

Returns:

ServerBackEndUrl - ServerBackEndUrl of current CADViewer settings

Type: string

cvjs_getServerLocation() → {string}

Get the current ServerLocation variable;

Source:

cadviewer_base_6_2_66.js, line 21678

Returns:

ServerLoction - server location of html Element on which CADViewer is located

Type: string

cvjs_getServerURL() → {string}

Get the current ServerURL variable;

Source:

cadviewer_base_6_2_66.js, line 21690

Returns:

ServerURL - server url of html Element on which CADViewer is located

Type: string

cvjs_getSpaceObjectDefaultLayer(floorplan_div) → {string}

Get the creation layer for Space Objects

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div

Source:

cadviewer_pro_6_2_66.js, line 44159

Returns:

layerName - name of the default Space Object layer

Type: string

cvjs_getSpaceObjectDirectXYCoord(floorplan_div, objectID, coordinate_flag) → {Array}

Get current Space Object Coordinates

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`objectID`	string	id of the object, used for pop-up highlight in "non-modal display" and for linking Space Objects with database entries
`coordinate_flag`	int	0 is SVG coordinates, 1 is DWG coordinates, 0 is default

Source:

cadviewer_pro_6_2_66.js, line 44069

Returns:

coords - x and y coordinate of object , null if undefined

Type: Array

cvjs_getSpaceObjectIdfromNode(Id) → {object}

Returns the first Id in the Space Object structure based on a nodeId

Parameters:

Name	Type	Description
`Id`	string	Node id of the Space Object in which to retrive the id data filed

Source:

cadviewer_pro_6_2_66.js, line 956

Returns:

value - Returns the id corresponding to the given nodeId, -1 if not found

Type: object

cvjs_getSpaceObjectIdList() → {array}

Returns a list with all Ids in the Space Object structure

Source:

cadviewer_pro_6_2_66.js, line 855

Returns:

value - Returns Id list

Type: array

cvjs_getSpaceObjectNamefromId(Id) → {object}

Returns the first Name in the Space Object structure based on an Id

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object in which to retrive the name

Source:

cadviewer_pro_6_2_66.js, line 935

Returns:

value - Returns the Name corresponding to the given Id, -1 if not found

Type: object

cvjs_getSpaceObjectNamefromNode(NodeId) → {object}

Returns the first Name in the Space Object structure based on a nodeId

Parameters:

Name	Type	Description
`NodeId`	string	Node id of the Space Object in which to retrive the Name data filed

Source:

cadviewer_pro_6_2_66.js, line 977

Returns:

value - Returns the Name corresponding to the given nodeId, -1 if not found

Type: object

cvjs_getSpaceObjectNamesList() → {array}

Returns a list with all Names in the Space Object structure

Source:

cadviewer_pro_6_2_66.js, line 872

Returns:

value - Returns Names list

Type: array

cvjs_getSpaceObjectNodefromId(Id) → {object}

Returns the first NodeId in the Space Object structure based on an Id

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object in which to retrive the Node id

Source:

cadviewer_pro_6_2_66.js, line 914

Returns:

value - Returns the NodeId corresponding to the given Id, -1 if not found

Type: object

cvjs_getSpaceObjectTypefromId(Id) → {object}

Returns the Type of a given Space Object ID

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object in which to retrive the corresponding Type

Source:

cadviewer_pro_6_2_66.js, line 890

Returns:

value - Returns the Type corresponding to the given Id, -1 if not found

Type: object

cvjs_getStickyNoteInfo() → {string}

Get the content of all StickyNotes

Source:

cadviewer_pro_6_2_66.js, line 17901

Returns:

stickyNoteContent - xml wrapped content: userid, id, name, date, text, page

Type: string

cvjs_getSvgToWorldUnits() → {float}

Returns the setting of SVG to World Units on the current drawing/page from the active floorplan_div

Source:

cadviewer_pro_6_2_66.js, line 29092

Returns:

svgToWorldUnits - conversion factor for measurements

Type: float

cvjs_GetURLParameter(sParam) → {string}

Retrieves a given parameter from the windows.location interface

Parameters:

Name	Type	Description
`sParam`	string	name of parameter to retrieve

Source:

cadviewer_base_6_2_66.js, line 24990

Returns:

the parameter if found, otherwise ""

Type: string

cvjs_GroupOff(layer)

Turn single Object Space group off - Object Spaces, Sticky Notes and Redlines are differentiated.

Parameters:

Name	Type	Description
`layer`	string	name of group to turn off

Source:

cadviewer_pro_6_2_66.js, line 1436

cvjs_GroupOn(layer)

Turn single Object Space group on - Object Spaces, Sticky Notes and Redlines are differentiated.

Parameters:

Name	Type	Description
`layer`	string	name of group to turn on

Source:

cadviewer_pro_6_2_66.js, line 1385

cvjs_GroupOn_AllOff(layer)

Turn single Object Space group on, all other groups are turned off - Object Spaces, Sticky Notes and Redlines are differentiated.

Parameters:

Name	Type	Description
`layer`	string	name of group to turn on

Source:

cadviewer_pro_6_2_66.js, line 1418

cvjs_GroupOn_OthersOff(layer)

Turn single Object Space group on, all other groups are turned off - Object Spaces, Sticky Notes and Redlines are differentiated.

Parameters:

Name	Type	Description
`layer`	string	name of group to turn on

Source:

cadviewer_pro_6_2_66.js, line 1399

cvjs_hatchSpace(rmid, graphicalPattern, colorHex, fillOpacity)

Apply a predefined pattern on a graphical Space Object

Parameters:

Name	Type	Description
`rmid`	string	Id of the Space Object object to add hatches
`graphicalPattern`	string	name of the hatch pattern, from a predefined list of patterns: "pattern_45degree_standard" "pattern_45degree_fine" "pattern_45degree_wide" "pattern_90degree_standard" "pattern_90degree_fine" "pattern_90degree_wide" "pattern_135degree_standard" "pattern_135degree_fine" "pattern_135degree_wide" "pattern_0degree_standard" "pattern_0degree_fine" "pattern_0degree_wide" "pattern_45degree_crosshatch_standard" "pattern_45degree_crosshatch_fine"
`colorHex`	string	color of hatch in hex form, for example: #FF0000
`fillOpacity`	float	fill opacity of pattern, value between 0 and 1

Source:

cadviewer_pro_6_2_66.js, line 45015

cvjs_hideAllInterfaceControls(floorplan_div)

Hide the page change modal

Parameters:

Name	Type	Description
`floorplan_div`	String	the div running CADViewer

Source:

cadviewer_base_6_2_66.js, line 12714

cvjs_hideAllRedlines_ExceptCurrentUser()

Hide all redlines except current userId

Source:

cadviewer_pro_6_2_66.js, line 4143

cvjs_hideAllRedlines_ExceptUser(userId)

Hide all redlines except named userId

Parameters:

Name	Type	Description
`userId`	string	the userId to be displayed, all other hidden

Source:

cadviewer_pro_6_2_66.js, line 4001

cvjs_hideAllRedlines_HiddenUsersList()

Hide all redlines with userId on the Hidden Users List

Source:

cadviewer_pro_6_2_66.js, line 4295

cvjs_hideInformationModal(floorplan_div)

Hides the information modal with text

Parameters:

Name	Type	Description
`floorplan_div`	string	name of div containing CADViewer canvas

Source:

cadviewer_base_6_2_66.js, line 1728

cvjs_hideToolTip()

Hides the standard tooltip previously shown with cvjs_showToolTipLocation(tiptext, x, y)

Source:

cadviewer_pro_6_2_66.js, line 695

cvjs_highlightAllSpaceObjects(roomstyle, layer)

Highlights all Space Objects with a given style on a specified external layer

Parameters:

Name	Type	Description
`roomstyle`	object	JSON formattet object containg the styling of the Space Objects
`layer`	string	external layer on which to draw the highlights

Source:

cadviewer_pro_6_2_66.js, line 39550

cvjs_highlightRoomCSS_layer(Id, roomstyle, layer)

Highlights a Space Object with a given style on a given external layer

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight

Source:

cadviewer_pro_6_2_66.js, line 39611

cvjs_highlightRoomCSS_layersort(Id, roomstyle, layer, layer2)

Highlights a Space Object with a given style on a given external layer

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight
`layer2`	string	external layer is repositioned and put on top of layer2

Source:

cadviewer_pro_6_2_66.js, line 39657

cvjs_highlightRoomCSS_layersortDiv(rmid, roomstyle, layer, floorplan_div) → {boolean}

Highlights a Space Object with a given style on a given external layer

Parameters:

Name	Type	Description
`rmid`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight
`floorplan_div`	string	name of the div on which the CADViewerJS instance is placed

Source:

cadviewer_pro_6_2_66.js, line 39628

Returns:

false if rmid not found otherwise true

Type: boolean

cvjs_highlightRoomImmediate(rmid, cleardrawing)

Highlight a Space Object using defined selectColors

Parameters:

Name	Type	Description
`rmid`	string	Id of space object modal to highlight
`cleardrawing`	boolean	clears all other highlights, before highlight, default is true, false will accumulate highlights

Source:

cadviewer_pro_6_2_66.js, line 40455

cvjs_highlightSpace(Id, roomstyle)

Highlights a Space Object with a given style on a given external layer

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject

Source:

cadviewer_pro_6_2_66.js, line 44865

cvjs_highlightSpaceBorderCSS_layersort(Id, roomstyle, layer, layer2, lineWeightFactor)

Highlights a Space Object bordr with a given style on a given external layer

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight
`layer2`	string	layer is repositioned and put on top of layer2
`lineWeightFactor`	floar	scale factor on border line weight

Source:

cadviewer_pro_6_2_66.js, line 39912

cvjs_highlightSpaceBorderCSS_layersortDiv(rmid, roomstyle, layer, floorplan_div, lineWeightFactor) → {boolean}

Highlights a Space Object bordr with a given style on a given external layer

Parameters:

Name	Type	Description
`rmid`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight
`floorplan_div`	string	name of the div on which the CADViewerJS instance is placed
`lineWeightFactor`	floar	scale factor on border line weight

Source:

cadviewer_pro_6_2_66.js, line 39881

Returns:

false if rmid not found otherwise true

Type: boolean

cvjs_highlightSpaceObjectDirect(floorplan_div, objectID, colorobject)

Highlight a Space Object with a css settings of a Color Object

Parameters:

Name	Type	Description
`floorplan_div`	string	name of floorplan div
`objectID`	string	id of the object, used for pop-up highlight in "non-modal display" and for linking Space Objects with database entries
`colorobject`	Object	Styleobject to apply to Space Object

Source:

cadviewer_pro_6_2_66.js, line 43693

cvjs_highlightSpaceObjectId(Id, roomstyle, layer)

Highlights a Space Object with a given style on a given external layer

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight

Source:

cadviewer_pro_6_2_66.js, line 39597

cvjs_highlightSpaceObjectIdDiv(Id, roomstyle, layer, floorplan_div)

Highlights a Space Object with a given style on a given external layer

Parameters:

Name	Type	Description
`Id`	string	Id of the Space Object to highlight
`roomstyle`	object	JSON formattet object containg the styling of the SpaceObject
`layer`	string	external layer on which to draw the highlight
`floorplan_div`	string	floorplan div with CADViewer instance

Source:

cadviewer_pro_6_2_66.js, line 39580

cvjs_highlightURL(Id, roomstyle, layer)

Highlights a URL with a given style on a given layer

Parameters:

Name	Type	Description
`Id`	string	Id of the URL to highlight
`roomstyle`	object	JSON formattet object containg the styling of the URL
`layer`	string	layer on which to draw the highlight

Source:

cadviewer_pro_6_2_66.js, line 39340

cvjs_IdObjectClicked() → {string}

Identify the id of the last Object Space selected - Object Spaces, Sticky Notes and Redlines are differentiated.

Source:

cadviewer_pro_6_2_66.js, line 42201

Returns:

objectId - The objectId is (-1) in case of no current object selected

Type: string

cvjs_idObjectClicked() → {string}

Identify the id of the last Object Space selected - Object Spaces, Sticky Notes and Redlines are differentiated.

Source:

cadviewer_pro_6_2_66.js, line 42185

Returns:

objectId - The objectId is (-1) in case of no current object selected

Type: string

cvjs_Init_ConversionServer(rest_api_url, rest_api_php, username, password)

Set up CADViewer for the call to the server side custom implementation of the API controlling conversions of DWG,DXF, and DWF files through AutoXchange

Parameters:

Name	Type	Description
`rest_api_url`	string	url of conversion rest api on server
`rest_api_php`	string	url of the PHP rest controller on server
`username`	string	the username of the server, "" if no username
`password`	string	the password of the server, "" if no username

Source:

cadviewer_base_6_2_66.js, line 15900

cvjs_InitCADViewer(floorplan_div, image, javascripts_folder)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`image`	string	folder - the path to the image location folder with icon settings, default is "+cvjs_imagesLocation+"
`javascripts_folder`	string	the path to javascripts folder with icon settings, default is ../javscripts/

Source:

cadviewer_base_6_2_66.js, line 13696

cvjs_InitCADViewer_app(floorplan_div, app, imagePathDirect)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`app`	string	folder - the path (relative or absolute) to the main application folder "app" , the default is the relative path "../app/"
`imagePathDirect`	string	direct paths to Images, typically "/assets/cadviewer/app/images/"

Source:

cadviewer_base_6_2_66.js, line 13419

cvjs_InitCADViewer_app_highLight(floorplan_div, app, cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes, cvjsRoomPolygonSelectAttributes)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`app`	string	folder - the path (relative or absolute) to the main application folder "app" , the default is the relative path "../app/", on Angular "/assets/cadviewer/app/
`cvjsRoomPolygonBaseAttributes`	object	javascript object containing fill, color and stroke properties for display of Space Object roompolygons
`cvjsRoomPolygonHighlightAttributes`	object	javascript object containing fill, color and stroke properties for mouseover highlight of Space Object roompolygons
`cvjsRoomPolygonSelectAttributes`	object	javascript object containing fill, color and stroke properties for select highlight of Space Object roompolygons

Source:

cadviewer_base_6_2_66.js, line 13503

cvjs_InitCADViewer_app_highLight_popUp(floorplan_div, app, cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes, cvjsRoomPolygonSelectAttributes, cvjsPopUpBody)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`app`	string	folder - the path (relative or absolute) to the main application folder "app" , the default is the relative path "../app/", on Angular "/assets/cadviewer/app/
`cvjsRoomPolygonBaseAttributes`	object	javascript object containing fill, color and stroke properties for display of Space Object roompolygons
`cvjsRoomPolygonHighlightAttributes`	object	javascript object containing fill, color and stroke properties for mouseover highlight of Space Object roompolygons
`cvjsRoomPolygonSelectAttributes`	object	javascript object containing fill, color and stroke properties for select highlight of Space Object roompolygons
`cvjsPopUpBody`	object	html/css styled object containing the content of the modal when selecting Space Objects

Source:

cadviewer_base_6_2_66.js, line 13597

cvjs_InitCADViewer_highLight(floorplan_div, cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes, cvjsRoomPolygonSelectAttributes)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`cvjsRoomPolygonBaseAttributes`	object	javascript object containing fill, color and stroke properties for display of Space Object roompolygons
`cvjsRoomPolygonHighlightAttributes`	object	javascript object containing fill, color and stroke properties for mouseover highlight of Space Object roompolygons
`cvjsRoomPolygonSelectAttributes`	object	javascript object containing fill, color and stroke properties for select highlight of Space Object roompolygons

Source:

cadviewer_base_6_2_66.js, line 13333

cvjs_InitCADViewer_highLight_popUp(floorplan_div, cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes, cvjsRoomPolygonSelectAttributes, cvjsPopUpBody)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`cvjsRoomPolygonBaseAttributes`	object	javascript object containing fill, color and stroke properties for display of Space Object roompolygons
`cvjsRoomPolygonHighlightAttributes`	object	javascript object containing fill, color and stroke properties for mouseover highlight of Space Object roompolygons
`cvjsRoomPolygonSelectAttributes`	object	javascript object containing fill, color and stroke properties for select highlight of Space Object roompolygons
`cvjsPopUpBody`	object	html/css styled object containing the content of the modal when selecting Space Objects

Source:

cadviewer_base_6_2_66.js, line 13241

cvjs_InitCADViewer_highLight_popUp_app(floorplan_div, app, cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes, cvjsRoomPolygonSelectAttributes, cvjsPopUpBody)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`app`	string	folder - the path (relative or absolute) to the main application folder "app" , the default is the relative path "../app/"
`cvjsRoomPolygonBaseAttributes`	object	javascript object containing fill, color and stroke properties for display of Space Object roompolygons
`cvjsRoomPolygonHighlightAttributes`	object	javascript object containing fill, color and stroke properties for mouseover highlight of Space Object roompolygons
`cvjsRoomPolygonSelectAttributes`	object	javascript object containing fill, color and stroke properties for select highlight of Space Object roompolygons
`cvjsPopUpBody`	object	html/css styled object containing the content of the modal when selecting Space Objects

Source:

cadviewer_base_6_2_66.js, line 13131

cvjs_InitCADViewer_highLight_popUp_dual_Id(floorplan_div, cvjsRoomPolygonBaseAttributes, cvjsRoomPolygonHighlightAttributes, cvjsRoomPolygonSelectAttributes, cvjsPopUpBody, cvjsPopUpBody2)

Initializes CADViewer, any of the methods cvjs_InitCADViewer_ must always be called setting up CADViewer

Parameters:

Name	Type	Description
`floorplan_div`	string	the SVG canvas object to which CADViewer is allocated
`cvjsRoomPolygonBaseAttributes`	object	javascript object containing fill, color and stroke properties for display of Space Object roompolygons
`cvjsRoomPolygonHighlightAttributes`	object	javascript object containing fill, color and stroke properties for mouseover highlight of Space Object roompolygons
`cvjsRoomPolygonSelectAttributes`	object	javascript object containing fill, color and stroke properties for select highlight of Space Object roompolygons
`cvjsPopUpBody`	object	html/css styled object containing the content of the modal when selecting Space Objects
`cvjsPopUpBody2`	object	second html/css styled object containing the content of the modal when selecting Space Objects, internally controlled based on type of Space Object

Source:

cadviewer_base_6_2_66.js, line 13030