Class: xrx.drawing.LayerBackground

xrx.drawing. LayerBackground

(private) new xrx.drawing.LayerBackground(canvas)

A class representing the background layer of a drawing canvas. The background layer can hold an image for image annotation.
Parameters:
Name Type Description
canvas xrx.drawing.Drawing The parent drawing canvas.
Source:

Extends

Members

(private) xrx.drawing.LayerBackground#drawing_

Inherited From:
Source:

(private) xrx.drawing.LayerBackground#group_

Inherited From:
Source:

(private) xrx.drawing.LayerBackground#image_ :xrx.shape.Image

Pointer to the background image object.
Type:
Source:

(private) xrx.drawing.LayerBackground#locked_

Inherited From:
Source:

(private) xrx.drawing.LayerBackground#shapes_

Inherited From:
Source:

Methods

xrx.drawing.LayerBackground#addShapes(shapes)

Adds shapes to the layer.
Parameters:
Name Type Description
shapes xrx.shape.Shape The shapes.
Inherited From:
Source:

(private) xrx.drawing.LayerBackground#create_()

Source:

xrx.drawing.LayerBackground#disposeInternal()

Disposes this layer.
Inherited From:
Source:

xrx.drawing.LayerBackground#draw()

Draws all shapes of the layer.
Inherited From:
Source:

xrx.drawing.LayerBackground#getDrawing() → {xrx.drawing.Drawing}

Returns the drawing object.
Inherited From:
Source:
Returns:
Type
xrx.drawing.Drawing

xrx.drawing.LayerBackground#getGroup() → {Object}

Returns the layers' group.
Inherited From:
Source:
Returns:
The group.
Type
Object

xrx.drawing.LayerBackground#getImage() → {xrx.shape.Image}

Returns the background image object.
Source:
Returns:
The background image object.
Type
xrx.shape.Image

xrx.drawing.LayerBackground#getShapes() → {xrx.shape.Shape}

Returns the shapes of the layer.
Inherited From:
Source:
Returns:
The shapes.
Type
xrx.shape.Shape

xrx.drawing.LayerBackground#isLocked() → {boolean}

Returns whether the layer is locked currently.
Inherited From:
Source:
Returns:
Locked or not.
Type
boolean

xrx.drawing.LayerBackground#removeShape(shape)

Removes one shape from the layer.
Parameters:
Name Type Description
shape xrx.shape.Shape The shape to remove.
Inherited From:
Source:

xrx.drawing.LayerBackground#removeShapes()

Removes all shapes from the layer;
Inherited From:
Source:

xrx.drawing.LayerBackground#setImage(image)

Sets a new background image.
Parameters:
Name Type Description
image HTMLImage The new image.
Source:

xrx.drawing.LayerBackground#setLocked(flag)

Locks or unlocks the layer so that the shapes are ignored by xrx.event.HandlerTarget.
Parameters:
Name Type Description
flag boolean Whether to lock or unlock the layer.
Inherited From:
Source: