#Engine

Main class that mounts the interactive floor plan diagram to a DOM element

Kind: global class

• Engine
  • new Engine(canvasId,startupOptions) ⇒ Engine
  • .currentLayer ⇒ Layer
  • .layers ⇒ Array.<Layer>
  • .measure ⇒ Measurement
  • .products ⇒ Array.<Product>
  • .state ⇒ EventState
  • .viewSetting ⇒ ViewSetting
  • .addMarker(pos,imgUrl,width,height) ⇒ Marker
  • .addNote(pos,text,options) ⇒ Note
  • .assignProduct(prod,shapeIds)
  • .clearColor(shapeId)
  • .clearSelection()
  • .clearTexture(shapeId)
  • .getAssignments(shapeId) ⇒ Array.<Assignment>
  • .getCutContext() ⇒ CutContext
  • .getPointInPoly(shapeId) ⇒ Point
  • .getParentShape(shape,shapeType) ⇒ Shape
  • .getShape(shapeId) ⇒ Shape
  • .isInView(pt) ⇒ boolean
  • .loadBlueprint(id) ⇒ HTMLImageElement
  • .loadCloudData(projectId) ⇒ boolean
  • .loadData(array) ⇒ boolean
  • .panCenterTo(point)
  • .partialShow(shapeIds)
  • .refresh()
  • .removeMarker(id)
  • .removeNote(id)
  • .resetView()
  • .select(shapeId)
  • .setColor(shapeId,color)
  • .setLayer(obj)
  • .setTexture(shapeId,imgUrl)
  • .unselect(shapeId)
  • .zoom(zoomIn)

#new Engine(canvasId,startupOptions)

Constructor that returns the diagram engine instance

Returns: Object - returns diagram engine instance

#.currentLayer

Get the current drawn layer

Kind: instance property of Engine

Returns: Object - returns the current drawn Layer

#.layers

Get all the layers in the diagram project

Kind: instance property of Engine

Returns: Object - returns the Layer array

#.measure

Get the measurement instance used in current diagram

Kind: instance property of Engine

Returns: Object - returns the Measurement object

#.products

Get all the products in the diagram project

Kind: instance property of Engine

Returns: Object - returns the product array

#.state

Get the current event state object to customize the event handler

Kind: instance property of Engine

Returns: Object - returns the EventState object

#.viewSetting

Get the current view setting of the diagram

Kind: instance property of Engine

Returns: Object - returns the ViewSetting object

#.addMarker(pos,imgUrl,width,height)

Add a custom marker to the diagram view

Kind: instance method of Engine

Returns: Object - returns a Marker object

#.removeMarker(id)

Remove the specified marker from the diagram view

Kind: instance method of Engine

Returns: void - returns nothing

#.loadBlueprint(id)

Load the buleprint in the current layer

Kind: instance method of Engine

Returns: HTMLImageElement - returns img element

#.loadCloudData(projectId)

Load the cloud diagram project data with it's unique identifier called projectId, and then draw to the canvas

The StartupOptions.apiKey must be passed with a new Engine object (see Cloud API integration)

Kind: instance method of Engine

Returns: boolean - returns success or fail

#.loadData(array)

Load the diagram project array buffer data, and then draw to the canvas

Here you must control how to get the project data by yourself

Kind: instance method of Engine

Returns: boolean - returns success or fail

#.refresh()

Redraw the floor plan diagram

Kind: instance method of Engine

Returns: void - returns nothing

#.assignProduct(prod,shapeIds)

Assign or replace the product to some plan regions.

Kind: instance method of Engine

Returns: void - returns nothing

#.resetView()

Zoom to fit all drawing and plan images into the current canvas view

Kind: instance method of Engine

Returns: void - returns nothing

#.setLayer(obj)

Set the current layer to be drawn

Kind: instance method of Engine

Returns: void - returns nothing

#.zoom(zoomIn)

Zoom in or zoom out in the diagram view

Kind: instance method of Engine

Returns: void - returns nothing

#.select(shapeId)

Select and highlight one room or plan region in a drawn diagram

Kind: instance method of Engine

Returns: void - returns nothing

#.unselect(shapeId)

Cancel select/highlight a room or plan region in a drawn diagram

Kind: instance method of Engine

Returns: void - returns nothing

#.clearSelection()

Clear all selected/highlighted shapes in a drawn diagram

Kind: instance method of Engine

Returns: void - returns nothing

#.getAssignments(shapeId)

Get the assignments in one shape

Kind: instance method of Engine

Returns: Object - returns the assignment array

#.getCutContext()

Get the context of a 'cut view'

Kind: instance method of Engine

Returns: Object - returns the CutContext object

#.getPointInPoly(shapeId)

Get the random point in the polygon region, for example, region, room or wall section

Kind: instance method of Engine

Returns: Object - returns the Point object

#.getShape(shapeId)

Find the map shape through the shape id

Kind: instance method of Engine

Returns: Object - returns the Shape object

#.getParentShape(shape,shapeType)

Find the first mapping parent shape by specify shape type

Kind: instance method of Engine

Returns: Object - returns the Shape object

#.panCenterTo(point)

Pan the diagram center to specify point.

Kind: instance method of Engine

Returns: void - returns nothing

#.addNote(pos,text,options)

Add a custom note/comment to the diagram view

Kind: instance method of Engine

Returns: Object - returns a Note object

#.removeNote(id)

Remove the specified note from the diagram view

Kind: instance method of Engine

Returns: void - returns nothing

#.setColor(shapeId,color)

Set the specify color into the specify region or room area

Kind: instance method of Engine

Returns: void - returns nothing

#.clearColor(shapeId)

Remove the specify color from the specify region or room area

Kind: instance method of Engine

Returns: void - returns nothing

#.setTexture(shapeId,imgUrl)

Set the specify image which will be repeated into the specify region or room area

Kind: instance method of Engine

Returns: void - returns nothing

#.clearTexture(shapeId)

Remove the specify repeated image from the specify region or room area

Kind: instance method of Engine

Returns: void - returns nothing

#.partialShow(shapeIds)

Only draw the specified top shapes in the diagram, others will be ignored

Kind: instance method of Engine

Returns: void - returns nothing

#.isInView(pt)

whether a coordinate point is in the view

Kind: instance method of Engine

Returns: boolean - returns true or false