Events

Context menu

context-menu-item-clicked: CustomEvent<{ source: HTMLElement } & MouseEvent>

Description: <enter description>

Parameters
source -

Layer tree

hoops-layer-tree-element-click: CustomEvent<{ layerId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
layerId -
source -

hoops-layer-tree-node-selected: CustomEvent<{ layerId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
layerId -
source -

hoops-layer-tree-visibility-changed: CustomEvent<{ layerId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
layerId -
source -

Layer tree element

hoops-layer-visibility-change: CustomEvent<{ layerId: number; visibility: boolean; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
layerId -
visibility -
source -

hoops-layer-node-visibility-change: CustomEvent<{ nodeId: number[]; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
nodeId -
source -

hoops-layer-tree-node-clicked: CustomEvent<{ layerId: number; nodeId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
layerId -
nodeId -
source -

hoops-layer-clicked: CustomEvent<{ layerId: number; nodeId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
layerId -
nodeId -
source -

Model tree

hoops-model-tree-node-click: CustomEvent<{ nodeId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
nodeId -
source -

Model tree node

hoops-model-tree-node-visibility-change: CustomEvent<{ nodeId: number; visibility: boolean; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
nodeId -
visibility -
source -

View tree

hoops-view-tree-node-click: CustomEvent<{ nodeId: number; source: HTMLElement } & BaseMouseEvent>

Description: <enter description>

Parameters
nodeId -
source -

WebViewer

hwvReady: CustomEvent<WebViewer>

Called when the HWV has been fully loaded in the browser and is ready to use.

Parameters
hwv - the Web Viewer object

hwvAddCuttingSection: CustomEvent<{ hwv: WebViewer; cuttingSection: core.ICuttingSection }>;

Called when a cutting section is added to the HWV.

Parameters
hwv - the Web Viewer object
cuttingSection - the new cutting section
  • hwvAssemblyTreeReady: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvBcfLoaded: CustomEvent<{ hwv: WebViewer; id: number; filename: Bcf.BCFName }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
number -
filename -
  • hwvBcfRemoved: CustomEvent<{ hwv: WebViewer; id: number }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
id -
  • hwvBeginInteraction: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvCamera: CustomEvent<{ hwv: WebViewer; camera: Camera }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
camera -
  • hwvConfigurationActivated: CustomEvent<{ hwv: WebViewer; nodeId: NodeId }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
nodeId -
  • hwvCuttingSectionsLoaded: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvEndInteraction: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvExplode: CustomEvent<{ hwv: WebViewer; magnitude: number }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
magnitude -
  • hwvHwfParseComplete: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvIncrementalSelectionBatchBegin: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvIncrementalSelectionBatchEnd: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvIncrementalSelectionEnd: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvInfo: CustomEvent<{ hwv: WebViewer; infoType: InfoType; message: string }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
infoType -
message -
  • hwvLineCreated: CustomEvent<{ hwv: WebViewer; line: Markup.Line.LineMarkup }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
line -
  • hwvLineDeleted: CustomEvent<{ hwv: WebViewer; line: Markup.Line.LineMarkup }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
line -
  • hwvLineLoaded: CustomEvent<{ hwv: WebViewer; line: Markup.Line.LineMarkup }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
line -
  • hwvMeasurementBegin: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvMissingModel: CustomEvent<{ hwv: WebViewer; modelPath: string }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
modelPath -
  • hwvModelLoadBegin: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvModelStructureReady: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvModelSwitchStart: CustomEvent<{ hwv: WebViewer; clearOnly: boolean }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
clearOnly -
  • hwvOverlayViewportSet: CustomEvent<{ hwv: WebViewer; overlayIndex: OverlayIndex }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
overlayIndex -
  • hwvRemoveCuttingSection: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvSceneReady: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvSheetActivated: CustomEvent<{ hwv: WebViewer; nodeId: SheetId }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
nodeId -
  • hwvSheetDeactivated: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvStreamingActivated: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvStreamingDeactivated: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvSubtreeDeleted: CustomEvent<{ hwv: WebViewer; modelRootIds: NodeId[] }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
modelRootIds -
  • hwvTimeout: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvTimeoutWarning: CustomEvent<{ hwv: WebViewer; minutesRemaining: number }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
minutesRemaining -
  • hwvTransitionBegin: CustomEvent<{ hwv: WebViewer; duration: number }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
duration -
  • hwvTransitionEnd: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvViewCreated: CustomEvent<{ hwv: WebViewer; view: Markup.MarkupView }>;

Emitted when a view is created.

Parameters
hwv - the Web Viewer object
view -
  • hwvViewDeactivated: CustomEvent<{ hwv: WebViewer; view: Markup.MarkupView }>;

Emitted when a view is deactivated

Parameters
hwv - the Web Viewer object
view -
  • hwvViewDeleted: CustomEvent<{ hwv: WebViewer; view: Markup.MarkupView }>;

Emitted when a view is deleted.

Parameters
hwv - the Web Viewer object
view -
  • hwvViewLoaded: CustomEvent<{ hwv: WebViewer; view: Markup.MarkupView }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
view -
  • hwvViewOrientation: CustomEvent<{ hwv: WebViewer; orientation: ViewOrientation }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
orientation -
  • hwvWalkOperatorActivated: CustomEvent<{ hwv: WebViewer }>;

Emitted when the walk operator is activated.

Parameters
hwv - the Web Viewer object
  • hwvWalkOperatorDeactivated: CustomEvent<{ hwv: WebViewer }>;

Emitted when the walk operator is deactivated.

Parameters
hwv - the Web Viewer object
  • hwvWebGlContextLost: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvWebsocketConnectionClosed: CustomEvent<{ hwv: WebViewer }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
  • hwvXHRonerror: CustomEvent<{ hwv: WebViewer; errorEvent: ErrorEvent }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
errorEvent -
  • hwvXHRonprogress: CustomEvent<{ hwv: WebViewer; progressEvent: ProgressEvent }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
progressEvent -
  • hwvCadViewCreated: CustomEvent<{ hwv: WebViewer; cadViewId: CadViewId; cadViewName: string }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
cadViewId - the ID of the CAD view created for this event
cadViewName - the name of the CAD view created for this event
  • hwvCappingIdle: CustomEvent<{ hwv: WebViewer; isIdle: boolean; cappedInstanceCount: number }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
isIdle -
cappedInstanceCount -
  • hwvContextMenu: CustomEvent<{ hwv: WebViewer; position: Point2; modifiers: KeyModifiers }>;

Emitted when the user activates the context menu.

Parameters
hwv - the Web Viewer object
position - the position of the click event
modifiers - the active modifier keys, if any
  • hwvCuttingPlaneDragStart: CustomEvent<{ hwv: WebViewer; cuttingSection: core.ICuttingSection; planeIndex: number; }>;

Emitted when the user starts dragging the cutting plane.

Parameters
hwv - the Web Viewer object
cuttingSection -
planeIndex -
  • hwvCuttingPlaneDrag: CustomEvent<{ hwv: WebViewer; cuttingSection: core.ICuttingSection; planeIndex: number; }>;

Emitted when the user drags the cutting plane.

Parameters
hwv - the Web Viewer object
cuttingSection -
planeIndex -
  • hwvCuttingPlaneDragEnd: CustomEvent<{ hwv: WebViewer; cuttingSection: core.ICuttingSection; planeIndex: number; }>;

Emitted when the user ends dragging the cutting plane.

Parameters
hwv - the Web Viewer object
cuttingSection -
planeIndex -
  • hwvFirstModelLoaded: CustomEvent<{ hwv: WebViewer; modelRootIds: NodeId[]; isHwf: boolean; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
modelRootIds -
isHwf -
  • hwvFrameDrawn: CustomEvent<{ hwv: WebViewer; camera: Camera; visiblePoints: number[] }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
camera -
visiblePoints -
  • hwvHandleEventStart: CustomEvent<{ hwv: WebViewer; eventType: HandleEventType; nodeIds: NodeId[]; initialMatrices: Matrix[]; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
eventType -
nodeIds -
initialMatrices -
  • hwvHandleEvent: CustomEvent<{ hwv: WebViewer; eventType: HandleEventType; nodeIds: NodeId[]; initialMatrices: Matrix[]; newMatrices: Matrix[]; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
eventType -
nodeIds -
initialMatrices -
  • hwvHandleEventEnd: CustomEvent<{ hwv: WebViewer; eventType: HandleEventType; nodeIds: NodeId[]; initialMatrices: Matrix[]; newMatrices: Matrix[]; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
eventType -
nodeIds -
initialMatrices -
  • hwvMeasurementCreated: CustomEvent<{ hwv: WebViewer; measurement: Operators.Markup.Measure.MeasureMarkup; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
measurement -
  • hwvMeasurementDeleted: CustomEvent<{ hwv: WebViewer; measurement: Operators.Markup.Measure.MeasureMarkup; }>;

Emitted when a measurement is deleted.

Parameters
hwv - the Web Viewer object
measurement -
  • hwvMeasurementHidden: CustomEvent<{ hwv: WebViewer; measurement: Operators.Markup.Measure.MeasureMarkup; }>;

Emitted when a measurement is hidden.

Parameters
hwv - the Web Viewer object
measurement -
  • hwvMeasurementLoaded: CustomEvent<{ hwv: WebViewer; measurement: Operators.Markup.Measure.MeasureMarkup; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
measurement -
  • hwvMeasurementShown: CustomEvent<{ hwv: WebViewer; measurement: Operators.Markup.Measure.MeasureMarkup; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
measurement -
  • hwvMeasurementValueSet: CustomEvent<{ hwv: WebViewer; measurement: Operators.Markup.Measure.MeasureMarkup; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
measurement -
  • hwvModelLoadFailure: CustomEvent<{ hwv: WebViewer; modelName: ScModelName; reason: string; error?: any; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
modelName -
reason -
error -
  • hwvModelStructureHeaderParsed: CustomEvent<{ hwv: WebViewer; filename: string; fileType: FileType; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
filename -
fileType -
  • hwvModelSwitched: CustomEvent<{ hwv: WebViewer; clearOnly: boolean; modelRootIds: NodeId[] }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
clearOnly -
modelRootIds -
  • hwvNoteTextCreated: CustomEvent<{ hwv: WebViewer; noteText: Operators.Markup.Note.NoteText }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
noteText - the text of the note associated with this event
  • hwvNoteTextHidden: CustomEvent<{ hwv: WebViewer; noteText: Operators.Markup.Note.NoteText }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
noteText - the text of the note associated with this event
  • hwvNoteTextShown: CustomEvent<{ hwv: WebViewer; noteText: Operators.Markup.Note.NoteText }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
noteText - the text of the note associated with this event
  • hwvRedlineCreated: CustomEvent<{ hwv: WebViewer; redlineMarkup: Markup.Redline.RedlineItem }>;

Emitted when redline text is created.

Parameters
hwv - the Web Viewer object
redlineMarkup - the text of the note associated with this event
  • hwvRedlineDeleted: CustomEvent<{ hwv: WebViewer; redlineMarkup: Markup.Redline.RedlineItem }>;

Emitted when redline text is deleted.

Parameters
hwv - the Web Viewer object
redlineMarkup - the text of the note associated with this event
  • hwvRedlineUpdated: CustomEvent<{ hwv: WebViewer; redlineMarkup: Markup.Redline.RedlineItem }>;

Emitted when redline text is updated.

Parameters
hwv - the Web Viewer object
redlineMarkup - the text of the note associated with this event
  • hwvSelectionArray: CustomEvent<{ hwv: WebViewer; selectionEvents: Event.NodeSelectionEvent[]; removed: boolean; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
selectionEvents -
removed -
  • hwvSubtreeLoaded: CustomEvent<{ hwv: WebViewer; modelRootIds: NodeId[]; source: NodeSource }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
modelRootIds -
source -
  • hwvViewAxes: CustomEvent<{ hwv: WebViewer; frontVector: Point3; upVector: Point3 }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
frontVector -
upVector -
  • hwvVisibilityChanged: CustomEvent<{ hwv: WebViewer; shownBodyIds: BodyId[]; hiddenBodyIds: BodyId[]; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
shownBodyIds -
hiddenBodyIds -
  • hwvXHRonloadend: CustomEvent<{ hwv: WebViewer; progressEvent: ProgressEvent; status: number; uri: string; }>;

Description: <enter description>

Parameters
hwv - the Web Viewer object
progressEvent -
status -
uri -