| svgcanvas.js | |
| Functions | |
| save | Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler. |
| getSvgString | Returns the current drawing as raw SVG XML text. |
| setSvgString | This function sets the current drawing as the input SVG XML. |
| createLayer | 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. |
| deleteCurrentLayer | This function clears the selection and then deletes the current layer from the drawing. |
| getNumLayers | This function returns the number of layers in the current drawing. |
| getLayer | This function returns the name of the ith layer. |
| getCurrentLayer | This function returns the name of the currently selected layer. |
| setCurrentLayer | This function sets the current layer. |
| renameCurrentLayer | This function renames the current layer. |
| setCurrentLayerPosition | This function changes the position of the current layer to the new value. |
| getLayerVisibility | This function returns whether the layer is visible. |
| setLayerVisibility | This function sets the visibility of the layer. |
| moveSelectedToLayer | This function moves the selected elements to layername. |
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.
| name | the name of the layer you want to switch to. |
true if the current layer was switched, otherwise false
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.
| newname | the new name you want to give the current layer. This name must be unique among all layer names. |
true if the rename succeeded, false otherwise.
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.
| newpos | The zero-based index of the new position of the layer. This should be between |
| 0 and (number of layers | 1) |
true if the current layer position was changed, false otherwise.
this.getLayerVisibility = function( layername )
This function returns whether the layer is visible. If the layer name is not valid, then this function returns false.
| layername | the name of the layer which you want to query. |
The visibility state of the layer, or false if the layer name was invalid.
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.
| layername | the name of the layer to change the visibility |
| bVisible | true/false, whether the layer should be visible |
true if the layer’s visibility was set, false otherwise
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.
| layername | the name of the layer you want to which you want to move the selected elements |
true if the selected elements were moved to the layer, false otherwise.
Serializes the current drawing into SVG XML text and returns it to the ‘saved’ handler.
this.save = function()
Returns the current drawing as raw SVG XML text.
this.getSvgString = function()
This function sets the current drawing as the input SVG XML.
this.setSvgString = function( xmlString )
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.createLayer = function( name )
This function clears the selection and then deletes the current layer from the drawing.
this.deleteCurrentLayer = function()
This function returns the number of layers in the current drawing.
this.getNumLayers = function()
This function returns the name of the ith layer.
this.getLayer = function( i )
This function returns the name of the currently selected layer.
this.getCurrentLayer = function()
This function sets the current layer.
this.setCurrentLayer = function( name )
This function renames the current layer.
this.renameCurrentLayer = function( newname )
This function changes the position of the current layer to the new value.
this.setCurrentLayerPosition = function( newpos )
This function returns whether the layer is visible.
this.getLayerVisibility = function( layername )
This function sets the visibility of the layer.
this.setLayerVisibility = function( layername, bVisible )
This function moves the selected elements to layername.
this.moveSelectedToLayer = function( layername )