MagiCAD

The product object returned from MagiCAD.load() function

{ 
     QModelParameters: Optional QModelParameters of model, in format "L=100;D=25;W1=130...",
     Filename: Optional file name and extension for the object to download, in format "example.dxf"
}

 { 
     QModelId: Optional QModelId of model, 
     QModelParameters: Optional QModelParameters of model, 
     ViewMode: one value of { 0=Rendered, 1=DimensionLabels, 2=DimensionValues },
     ViewPosition: one value of { 0=Default, 1=Front, 2=Right, 3=Left, 4=Top, 5=Bottom, 6=IsometricLeft, 7=IsometricRight } 
 }

Product identifier (GUID)

Value = {Unknown, AnyFluid, SupplyFluid, ReturnFluid, ColdWater, HotWater, FireHydrant, HotSupplyFluid, Sprinkler, Sewer, AnyAir, SupplyAir, ExtractAir, OutdoorSupply, OutdoorExhau}

Specified flow

Specified Fan Speed

{ 
     QModelId: Optional QModelId of model, 
     QModelParameters: Optional QModelParameters of model,
     ViewPosition: one value of { 0=Default, 1=Front, 2=Right, 3=Left, 4=Top, 5=Bottom, 6=IsometricLeft, 7=IsometricRight } 
}

Example object:
{ 
 client_id: 'your_client_id', 
 popup_redirect_uri: 'callback file url when using popup signin method'
 redirect_uri: 'callback file url when using redirect signin method' // if given, popup_redirect_uri will be ignored browser redirection is being used instead of popup
 post_logout_redirect_uri: 'callback file url to direct the user to after successful sign-out' 
 enableX3D: true, // default value is true and x3dom library will be loaded
 onLoadUser: function(user) { console.log(user.username); }, // Set event handler to get signed in user if any exists e.g. case when page refreshed
 onSignin: function(user) { console.log(user.username); }, // Set event handler to perform some action on user signin
 onSignout: function() { console.log('user signed out'); }, // Set event handler to perform some action on user signout
 onRenderX3D: function() { console.log('x3d rendered'); }, // Set event handler to perform some action after rendering x3d image
 onGetDpTot function(result) { console.log(result); }, // Set event handler to perform some action with calculation result
 onFindOptimalSpeed: function(result) { console.log(result); } // Set event handler to perform some action with calculation result
}

(optional)

{ 
     productId: string, 
     articleNumber: string, 
     manufacturerId: string 
 }

where manufacturerId and either productId or articleNumber is defined.

Container identifier

Boolean value should transparent image be used

Container identifier

Boolean value whether transparent image should be used

  Basic example:

  {
      x3dUri: location of x3d,
      imageUri: location of image
      containerId: identifier of the container for x3d,
  }

 Or, to get 3D view with custom model parameters:
 { 
      QModelId: the identifier of the 3D geometry (GUID format), 
      QModelParameters: Optional QModelParameters of model, 
      ViewMode: one value of { 0=Rendered, 1=DimensionLabels, 2=DimensionValues,
      containerId: identifier of the container for x3d,
  }

  Or, to get 3D view with product external reference and variant qpd id:
  {
      productId: the external reference of the product (GUID format)
      variantQpdId: the qpd id of the specific variant,
      containerId: identifier of the container for x3d
  }

  Or, to get 3D view with custom level of detail (LOD):
  { 
      QModelId: the identifier of the 3D geometry (GUID format), 
      QModelParameters: Optional QModelParameters of model, 
      LodLevel: one value of { 0=Preview, 1=MC LOD 200, 2=MC LOD 300, 3=MC LOD 350 },
      containerId: identifier of the container for x3d,
   }

 

Update existing container with new image url

Product data

Example:
 { 
     type: diagramType, 
     elementId: 'el', 
     dataElementId: 'dataEl' 
 } 
where diagramType is one of { Ventilation, Heating, Cooling, SupplyAir, ExtractAir, Radiator, Pump }