Class CMScene

Constructor for the CMScene class @public, @constructs

Object Functions

ReturnsFunctionThrows
LayerIndex AddBackground(TheLayer)
SetSelectedBackgroundIndex(BackgroundIndex)
SetBackgroundStyle(BackgroundStyle)
GetLayer(Index)
LayerIndex GetLayerIndex(TheLayer)
MoveLayerUp(Index)
MoveLayerDown(Index)
DeleteLayer(Index)
MoveLayer(TheLayer, NewIndex)
AddMapElement(TheElement)
MouseDown(TheView, RefX, RefY)
MouseMove(TheView, RefX, RefY)
MouseUp(TheView, RefX, RefY)
Resize(TheView)
Paint(TheView)
Repaint(TheView)
IncrementRepaintBlocks()
DecrementRepaintBlocks()
LayerSettingsChanged(TheLayer)
AddLayerList(TheElement)
AddBackgroundList(TheElement)
SetAttributeTableElement(NewAttributeTableElement)
UnselectAll()

Object Functions


LayerIndex AddBackground(TheLayer)

Adds a background layer to the scene

Parameters:
    TheLayer

Returns: LayerIndex null


SetSelectedBackgroundIndex(BackgroundIndex)

Sets which background will be selected for painting

Parameters:
    BackgroundIndex -


SetBackgroundStyle(BackgroundStyle)

Sets the background style

Parameters:
    BackgroundStyle -


GetLayer(Index)

Return the layer object at the specified index

Parameters:
    Index -


LayerIndex GetLayerIndex(TheLayer)

Return the index for the specified layer. If the layer does not appear in the CMScene, return -1

Parameters:
    TheLayer -

Returns: LayerIndex null


MoveLayerUp(Index)

Swap the layer with the one above it.

Parameters:
    Index -


MoveLayerDown(Index)

Swap the specified layer with the one below it.

Parameters:
    Index -


DeleteLayer(Index)

Remove the layer at the specified index from the list of layers

Parameters:
    Index -


MoveLayer(TheLayer, NewIndex)

Moves a layer to a new position in the layer list

Parameters:
    TheLayer -
    NewIndex -


AddMapElement(TheElement)

Add a new map element to the scene (e.g. a scale bar)

Parameters:
    TheElement -


MouseDown(TheView, RefX, RefY)

Called when there is a mouse down event received by CanvasMap

Parameters:
    TheView - the view that recieved the event
    RefX - reference horiziontal coordinate value
    RefY - reference vertical coordinate value


MouseMove(TheView, RefX, RefY)

Called when there is a mouse move event received by CanvasMap

Parameters:
    TheView - the view that recieved the event
    RefX - reference horiziontal coordinate value
    RefY - reference vertical coordinate value


MouseUp(TheView, RefX, RefY)

Called when there is a mouse up event received by CanvasMap

Parameters:
    TheView - the view that recieved the event
    RefX - reference horiziontal coordinate value
    RefY - reference vertical coordinate value


Resize(TheView)

Called when the window is resized

Parameters:
    TheView - the view that recieved the event


Paint(TheView)

Paint the layers into the view

Parameters:
    TheView - the view that recieved the event


Repaint(TheView)

Called by the layers to repaint the scene

Parameters:
    TheView - the view that recieved the event


IncrementRepaintBlocks()

Called to block repainting when a large number of settings are made that would all generate repaints.


DecrementRepaintBlocks()

Calls to IncrementRepaintBlocks must be paired with calls to this function. generate repaints.


LayerSettingsChanged(TheLayer)

Called when the layers settings changed.

Parameters:
    TheLayer


AddLayerList(TheElement)

Add the layer list to the specified DOM element. This will typically be a div tag in the map page. Override to provide your own layer list.

Parameters:
    TheElement


AddBackgroundList(TheElement)

Add the background layer list to the specified DOM element. This will typically be a div tag in the map page. Override to provide your own layer list.

Parameters:
    TheElement


SetAttributeTableElement(NewAttributeTableElement)

Sets the DOM element that will be used to display the attribute table

Parameters:
    NewAttributeTableElement


UnselectAll()

Unselect all information in the layers