diff --git a/docs/files/svgcanvas-js.html b/docs/files/svgcanvas-js.html index cc96ad99..b1ce4cae 100644 --- a/docs/files/svgcanvas-js.html +++ b/docs/files/svgcanvas-js.html @@ -11,37 +11,45 @@ if (browserType) {document.write("
");if (browserV -

svgcanvas.js

Summary
svgcanvas.js
Functions
saveSerializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
getSvgStringReturns the current drawing as raw SVG XML text.
setSvgStringThis function sets the current drawing as the input SVG XML.
createLayerThis function clears the selection and then creates a new top-level layer in the drawing with the given name and sets the current layer to it.
deleteCurrentLayerThis function clears the selection and then deletes the current layer from the drawing.
getNumLayersThis function returns the number of layers in the current drawing.
getLayerThis function returns the name of the ith layer.
getCurrentLayerThis function returns the name of the currently selected layer.
setCurrentLayerThis function sets the current layer.
renameCurrentLayerThis function renames the current layer.
setCurrentLayerPositionThis function changes the position of the current layer to the new value.
getLayerVisibilityThis function returns whether the layer is visible.
setLayerVisibilityThis function sets the visibility of the layer.
moveSelectedToLayerThis function moves the selected elements to layername.
+

svgcanvas.js

Summary
svgcanvas.js
Functions
clearSelectionClears the selection.
addToSelectionAdds a list of elements to the selection.
removeFromSelectionRemoves elements from the selection.
saveSerializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
getSvgStringReturns the current drawing as raw SVG XML text.
setSvgStringThis function sets the current drawing as the input SVG XML.
createLayerCreates a new top-level layer in the drawing with the given name, sets the current layer to it, and then clears the selection This function then calls the ‘changed’ handler.
deleteCurrentLayerDeletes the current layer from the drawing and then clears the selection.
getNumLayersReturns the number of layers in the current drawing.
getLayerReturns the name of the ith layer.
getCurrentLayerReturns the name of the currently selected layer.
setCurrentLayerSets the current layer.
renameCurrentLayerRenames the current layer.
setCurrentLayerPositionChanges the position of the current layer to the new value.
getLayerVisibilityReturns whether the layer is visible.
setLayerVisibilitySets the visibility of the layer.
moveSelectedToLayerMoves the selected elements to layername.
clearClears the current document.

Functions

+

clearSelection

this.clearSelection = function()

Clears the selection.  The ‘selected’ handler is then called.

+ +

addToSelection

this.addToSelection = function(elemsToAdd,
showGrips)

Adds a list of elements to the selection.  The ‘selected’ handler is then called.

Parameters

elemsToAddan array of DOM elements to add to the selection
showGripsa boolean flag indicating whether the resize grips should be shown
+ +

removeFromSelection

this.removeFromSelection = function(elemsToRemove)

Removes elements from the selection.

Parameters

elemsToRemovean array of elements to remove from selection
+

save

this.save = function()

Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.  This function also includes the XML prolog.

Returns

Nothing

getSvgString

this.getSvgString = function()

Returns the current drawing as raw SVG XML text.

Returns

The current drawing as raw SVG XML text.

setSvgString

this.setSvgString = function(xmlString)

This function sets the current drawing as the input SVG XML.

Parameters

xmlStringThe SVG as XML text.

Returns

This function returns false if the set was unsuccessful, true otherwise.

-

createLayer

this.createLayer = function(name)

This function clears the selection and then creates a new top-level layer in the drawing with the given name and sets the current layer to it.  This function then calls the ‘changed’ handler.

Parameters

nameThe given name
+

createLayer

this.createLayer = function(name)

Creates a new top-level layer in the drawing with the given name, sets the current layer to it, and then clears the selection This function then calls the ‘changed’ handler.  This is an undoable action.

Parameters

nameThe given name
-

deleteCurrentLayer

this.deleteCurrentLayer = function()

This function clears the selection and then deletes the current layer from the drawing.  This function then calls the ‘changed’ handler.

+

deleteCurrentLayer

this.deleteCurrentLayer = function()

Deletes the current layer from the drawing and then clears the selection.  This function then calls the ‘changed’ handler.  This is an undoable action.

-

getNumLayers

this.getNumLayers = function()

This function returns the number of layers in the current drawing.

Returns

The number of layers in the current drawing.

+

getNumLayers

this.getNumLayers = function()

Returns the number of layers in the current drawing.

Returns

The number of layers in the current drawing.

-

getLayer

this.getLayer = function(i)

This function returns the name of the ith layer.  If the index is out of range, then an empty string is returned.

Parameters

ithe zero-based index of the layer you are querying.

Returns

The name of the ith layer

+

getLayer

this.getLayer = function(i)

Returns the name of the ith layer.  If the index is out of range, an empty string is returned.

Parameters

ithe zero-based index of the layer you are querying.

Returns

The name of the ith layer

-

getCurrentLayer

this.getCurrentLayer = function()

This function returns the name of the currently selected layer.  If an error occurs, an empty string is returned.

Returns

The name of the currently active layer.

+

getCurrentLayer

this.getCurrentLayer = function()

Returns the name of the currently selected layer.  If an error occurs, an empty string is returned.

Returns

The name of the currently active layer.

-

setCurrentLayer

this.setCurrentLayer = function(name)

This function sets the current layer.  If the name is not a valid layer name, then this function returns false.  Otherwise it returns true.  This is not an undo-able action.

Parameters

namethe name of the layer you want to switch to.

Returns

true if the current layer was switched, otherwise false

+

setCurrentLayer

this.setCurrentLayer = function(name)

Sets the current layer.  If the name is not a valid layer name, then this function returns false.  Otherwise it returns true.  This is not an undo-able action.

Parameters

namethe name of the layer you want to switch to.

Returns

true if the current layer was switched, otherwise false

-

renameCurrentLayer

this.renameCurrentLayer = function(newname)

This function renames the current layer.  This is an undo-able action.  If the layer name is not valid (i.e. unique), then this function does nothing and returns false, otherwise it returns true.

Parameters

newnamethe new name you want to give the current layer.  This name must be unique among all layer names.

Returns

true if the rename succeeded, false otherwise.

+

renameCurrentLayer

this.renameCurrentLayer = function(newname)

Renames the current layer.  If the layer name is not valid (i.e. unique), then this function does nothing and returns false, otherwise it returns true.  This is an undo-able action.

Parameters

newnamethe new name you want to give the current layer.  This name must be unique among all layer names.

Returns

true if the rename succeeded, false otherwise.

-

setCurrentLayerPosition

this.setCurrentLayerPosition = function(newpos)

This function changes the position of the current layer to the new value.  This is an undo-able action.  If the new index is not valid, this function does nothing and returns false, otherwise it returns true.

Parameters

newposThe zero-based index of the new position of the layer.  This should be between
0 and (number of layers1)

Returns

true if the current layer position was changed, false otherwise.

+

setCurrentLayerPosition

this.setCurrentLayerPosition = function(newpos)

Changes the position of the current layer to the new value.  If the new index is not valid, this function does nothing and returns false, otherwise it returns true.  This is an undo-able action.

Parameters

newposThe zero-based index of the new position of the layer.  This should be between
0 and (number of layers1)

Returns

true if the current layer position was changed, false otherwise.

-

getLayerVisibility

this.getLayerVisibility = function(layername)

This function returns whether the layer is visible.  If the layer name is not valid, then this function returns false.

Parameters

layernamethe name of the layer which you want to query.

Returns

The visibility state of the layer, or false if the layer name was invalid.

+

getLayerVisibility

this.getLayerVisibility = function(layername)

Returns whether the layer is visible.  If the layer name is not valid, then this function returns false.

Parameters

layernamethe name of the layer which you want to query.

Returns

The visibility state of the layer, or false if the layer name was invalid.

-

setLayerVisibility

this.setLayerVisibility = function(layername,
bVisible)

This function sets the visibility of the layer.  This is an undo-able action.  If the layer name is not valid, this function return false, otherwise it returns true.

Parameters

layernamethe name of the layer to change the visibility
bVisibletrue/false, whether the layer should be visible

Returns

true if the layer’s visibility was set, false otherwise

+

setLayerVisibility

this.setLayerVisibility = function(layername,
bVisible)

Sets the visibility of the layer.  If the layer name is not valid, this function return false, otherwise it returns true.  This is an undo-able action.

Parameters

layernamethe name of the layer to change the visibility
bVisibletrue/false, whether the layer should be visible

Returns

true if the layer’s visibility was set, false otherwise

-

moveSelectedToLayer

this.moveSelectedToLayer = function(layername)

This function moves the selected elements to layername.  This is an undo-able action.  If the name is not a valid layer name, then false is returned.  Otherwise it returns true.

Parameters

layernamethe name of the layer you want to which you want to move the selected elements

Returns

true if the selected elements were moved to the layer, false otherwise.

+

moveSelectedToLayer

this.moveSelectedToLayer = function(layername)

Moves the selected elements to layername.  If the name is not a valid layer name, then false is returned.  Otherwise it returns true.  This is an undo-able action.

Parameters

layernamethe name of the layer you want to which you want to move the selected elements

Returns

true if the selected elements were moved to the layer, false otherwise.

+ +

clear

this.clear = function()

Clears the current document.  This is not an undoable action.

@@ -49,14 +57,14 @@ if (browserType) {document.write("
");if (browserV - -
this.save = function()
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.getSvgString = function()
Returns the current drawing as raw SVG XML text.
this.setSvgString = function(xmlString)
This function sets the current drawing as the input SVG XML.
this.createLayer = function(name)
This function clears the selection and then creates a new top-level layer in the drawing with the given name and sets the current layer to it.
this.deleteCurrentLayer = function()
This function clears the selection and then deletes the current layer from the drawing.
this.getNumLayers = function()
This function returns the number of layers in the current drawing.
this.getLayer = function(i)
This function returns the name of the ith layer.
this.getCurrentLayer = function()
This function returns the name of the currently selected layer.
this.setCurrentLayer = function(name)
This function sets the current layer.
this.renameCurrentLayer = function(newname)
This function renames the current layer.
this.setCurrentLayerPosition = function(newpos)
This function changes the position of the current layer to the new value.
this.getLayerVisibility = function(layername)
This function returns whether the layer is visible.
this.setLayerVisibility = function(layername,
bVisible)
This function sets the visibility of the layer.
this.moveSelectedToLayer = function(layername)
This function moves the selected elements to layername.
+
this.clearSelection = function()
Clears the selection.
this.addToSelection = function(elemsToAdd,
showGrips)
Adds a list of elements to the selection.
this.removeFromSelection = function(elemsToRemove)
Removes elements from the selection.
this.save = function()
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.getSvgString = function()
Returns the current drawing as raw SVG XML text.
this.setSvgString = function(xmlString)
This function sets the current drawing as the input SVG XML.
this.createLayer = function(name)
Creates a new top-level layer in the drawing with the given name, sets the current layer to it, and then clears the selection This function then calls the ‘changed’ handler.
this.deleteCurrentLayer = function()
Deletes the current layer from the drawing and then clears the selection.
this.getNumLayers = function()
Returns the number of layers in the current drawing.
this.getLayer = function(i)
Returns the name of the ith layer.
this.getCurrentLayer = function()
Returns the name of the currently selected layer.
this.setCurrentLayer = function(name)
Sets the current layer.
this.renameCurrentLayer = function(newname)
Renames the current layer.
this.setCurrentLayerPosition = function(newpos)
Changes the position of the current layer to the new value.
this.getLayerVisibility = function(layername)
Returns whether the layer is visible.
this.setLayerVisibility = function(layername,
bVisible)
Sets the visibility of the layer.
this.moveSelectedToLayer = function(layername)
Moves the selected elements to layername.
this.clear = function()
Clears the current document.
diff --git a/docs/index.html b/docs/index.html index 3aa33024..635c3177 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/index/Files.html b/docs/index/Files.html index 1a211415..6be68e67 100644 --- a/docs/index/Files.html +++ b/docs/index/Files.html @@ -11,7 +11,7 @@ if (browserType) {document.write("
");if (browserV -
File Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
S
 svgcanvas-mine.js
 svgcanvas.js
+
File Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
S
 svgcanvas.js
@@ -21,7 +21,7 @@ if (browserType) {document.write("
");if (browserV - diff --git a/docs/index/Functions.html b/docs/index/Functions.html index 28a7f9b0..25410d99 100644 --- a/docs/index/Functions.html +++ b/docs/index/Functions.html @@ -11,29 +11,33 @@ if (browserType) {document.write("
");if (browserV -
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
C
 createLayer
svgcanvas-mine.jssvgcanvas.js
D
 deleteCurrentLayer
svgcanvas-mine.jssvgcanvas.js
G
 getCurrentLayer
svgcanvas-mine.jssvgcanvas.js
 getLayer
svgcanvas-mine.jssvgcanvas.js
 getLayerVisibility
svgcanvas-mine.jssvgcanvas.js
 getNumLayers
svgcanvas-mine.jssvgcanvas.js
 getSvgString
svgcanvas-mine.jssvgcanvas.js
M
 moveSelectedToLayer
svgcanvas-mine.jssvgcanvas.js
R
 renameCurrentLayer
svgcanvas-mine.jssvgcanvas.js
S
 save
svgcanvas-mine.jssvgcanvas.js
 setCurrentLayer
svgcanvas-mine.jssvgcanvas.js
 setCurrentLayerPosition
svgcanvas-mine.jssvgcanvas.js
 setLayerVisibility
svgcanvas-mine.jssvgcanvas.js
 setSvgString
svgcanvas-mine.jssvgcanvas.js
+
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 addToSelection
C
 clear
 clearSelection
 createLayer
D
 deleteCurrentLayer
G
 getCurrentLayer
 getLayer
 getLayerVisibility
 getNumLayers
 getSvgString
M
 moveSelectedToLayer
R
 removeFromSelection
 renameCurrentLayer
S
 save
 setCurrentLayer
 setCurrentLayerPosition
 setLayerVisibility
 setSvgString
-
this.createLayer = function(name)
This function clears the selection and then creates a new top-level layer in the drawing with the given name and sets the current layer to it.
+
this.addToSelection = function(elemsToAdd,
showGrips)
Adds a list of elements to the selection.
-
this.deleteCurrentLayer = function()
This function clears the selection and then deletes the current layer from the drawing.
+
this.clear = function()
Clears the current document.
this.clearSelection = function()
Clears the selection.
this.createLayer = function(name)
Creates a new top-level layer in the drawing with the given name, sets the current layer to it, and then clears the selection This function then calls the ‘changed’ handler.
-
this.getCurrentLayer = function()
This function returns the name of the currently selected layer.
this.getLayer = function(i)
This function returns the name of the ith layer.
this.getLayerVisibility = function(layername)
This function returns whether the layer is visible.
this.getNumLayers = function()
This function returns the number of layers in the current drawing.
this.getSvgString = function()
Returns the current drawing as raw SVG XML text.
+
this.deleteCurrentLayer = function()
Deletes the current layer from the drawing and then clears the selection.
-
this.moveSelectedToLayer = function(layername)
This function moves the selected elements to layername.
+
this.getCurrentLayer = function()
Returns the name of the currently selected layer.
this.getLayer = function(i)
Returns the name of the ith layer.
this.getLayerVisibility = function(layername)
Returns whether the layer is visible.
this.getNumLayers = function()
Returns the number of layers in the current drawing.
this.getSvgString = function()
Returns the current drawing as raw SVG XML text.
-
this.renameCurrentLayer = function(newname)
This function renames the current layer.
+
this.moveSelectedToLayer = function(layername)
Moves the selected elements to layername.
-
this.save = function()
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.setCurrentLayer = function(name)
This function sets the current layer.
this.setCurrentLayerPosition = function(newpos)
This function changes the position of the current layer to the new value.
this.setLayerVisibility = function(layername,
bVisible)
This function sets the visibility of the layer.
this.setSvgString = function(xmlString)
This function sets the current drawing as the input SVG XML.
+
this.removeFromSelection = function(elemsToRemove)
Removes elements from the selection.
this.renameCurrentLayer = function(newname)
Renames the current layer.
+ + + +
this.save = function()
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.setCurrentLayer = function(name)
Sets the current layer.
this.setCurrentLayerPosition = function(newpos)
Changes the position of the current layer to the new value.
this.setLayerVisibility = function(layername,
bVisible)
Sets the visibility of the layer.
this.setSvgString = function(xmlString)
This function sets the current drawing as the input SVG XML.
@@ -41,7 +45,7 @@ if (browserType) {document.write("
");if (browserV - diff --git a/docs/index/General.html b/docs/index/General.html index 3d4122df..1335eea2 100644 --- a/docs/index/General.html +++ b/docs/index/General.html @@ -11,13 +11,17 @@ if (browserType) {document.write("
");if (browserV -
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
C
 createLayer
svgcanvas-mine.jssvgcanvas.js
D
 deleteCurrentLayer
svgcanvas-mine.jssvgcanvas.js
F
 Functions
svgcanvas-mine.jssvgcanvas.js
G
 getCurrentLayer
svgcanvas-mine.jssvgcanvas.js
 getLayer
svgcanvas-mine.jssvgcanvas.js
 getLayerVisibility
svgcanvas-mine.jssvgcanvas.js
 getNumLayers
svgcanvas-mine.jssvgcanvas.js
 getSvgString
svgcanvas-mine.jssvgcanvas.js
M
 moveSelectedToLayer
svgcanvas-mine.jssvgcanvas.js
R
 renameCurrentLayer
svgcanvas-mine.jssvgcanvas.js
S
 save
svgcanvas-mine.jssvgcanvas.js
 setCurrentLayer
svgcanvas-mine.jssvgcanvas.js
 setCurrentLayerPosition
svgcanvas-mine.jssvgcanvas.js
 setLayerVisibility
svgcanvas-mine.jssvgcanvas.js
 setSvgString
svgcanvas-mine.jssvgcanvas.js
 svgcanvas-mine.js
 svgcanvas.js
+
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 addToSelection
C
 clear
 clearSelection
 createLayer
D
 deleteCurrentLayer
F
 Functions
G
 getCurrentLayer
 getLayer
 getLayerVisibility
 getNumLayers
 getSvgString
M
 moveSelectedToLayer
R
 removeFromSelection
 renameCurrentLayer
S
 save
 setCurrentLayer
 setCurrentLayerPosition
 setLayerVisibility
 setSvgString
 svgcanvas.js
-
this.createLayer = function(name)
This function clears the selection and then creates a new top-level layer in the drawing with the given name and sets the current layer to it.
+
this.addToSelection = function(elemsToAdd,
showGrips)
Adds a list of elements to the selection.
-
this.deleteCurrentLayer = function()
This function clears the selection and then deletes the current layer from the drawing.
+
this.clear = function()
Clears the current document.
this.clearSelection = function()
Clears the selection.
this.createLayer = function(name)
Creates a new top-level layer in the drawing with the given name, sets the current layer to it, and then clears the selection This function then calls the ‘changed’ handler.
+ + + +
this.deleteCurrentLayer = function()
Deletes the current layer from the drawing and then clears the selection.
@@ -25,19 +29,19 @@ if (browserType) {document.write("
");if (browserV -
this.getCurrentLayer = function()
This function returns the name of the currently selected layer.
this.getLayer = function(i)
This function returns the name of the ith layer.
this.getLayerVisibility = function(layername)
This function returns whether the layer is visible.
this.getNumLayers = function()
This function returns the number of layers in the current drawing.
this.getSvgString = function()
Returns the current drawing as raw SVG XML text.
+
this.getCurrentLayer = function()
Returns the name of the currently selected layer.
this.getLayer = function(i)
Returns the name of the ith layer.
this.getLayerVisibility = function(layername)
Returns whether the layer is visible.
this.getNumLayers = function()
Returns the number of layers in the current drawing.
this.getSvgString = function()
Returns the current drawing as raw SVG XML text.
-
this.moveSelectedToLayer = function(layername)
This function moves the selected elements to layername.
+
this.moveSelectedToLayer = function(layername)
Moves the selected elements to layername.
-
this.renameCurrentLayer = function(newname)
This function renames the current layer.
+
this.removeFromSelection = function(elemsToRemove)
Removes elements from the selection.
this.renameCurrentLayer = function(newname)
Renames the current layer.
-
this.save = function()
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.setCurrentLayer = function(name)
This function sets the current layer.
this.setCurrentLayerPosition = function(newpos)
This function changes the position of the current layer to the new value.
this.setLayerVisibility = function(layername,
bVisible)
This function sets the visibility of the layer.
this.setSvgString = function(xmlString)
This function sets the current drawing as the input SVG XML.
+
this.save = function()
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.setCurrentLayer = function(name)
Sets the current layer.
this.setCurrentLayerPosition = function(newpos)
Changes the position of the current layer to the new value.
this.setLayerVisibility = function(layername,
bVisible)
Sets the visibility of the layer.
this.setSvgString = function(xmlString)
This function sets the current drawing as the input SVG XML.
@@ -45,7 +49,7 @@ if (browserType) {document.write("
");if (browserV - diff --git a/docs/javascript/searchdata.js b/docs/javascript/searchdata.js index f0356f01..1d961500 100644 --- a/docs/javascript/searchdata.js +++ b/docs/javascript/searchdata.js @@ -32,7 +32,7 @@ var indexSectionsWithContent = { "Functions": { "Symbols": false, "Numbers": false, - "A": false, + "A": true, "B": false, "C": true, "D": true, diff --git a/docs/search/FilesS.html b/docs/search/FilesS.html index 1f16b8b9..a8c4e958 100644 --- a/docs/search/FilesS.html +++ b/docs/search/FilesS.html @@ -11,7 +11,7 @@ if (browserType) {document.write("
");if (browserV -
Loading...
Searching...
No Matches