# MarkupView

class `Markup.``MarkupView`()

  ## Index

  Methods

  - `addMarkupItem`
  - `getCamera`
  - `getColorMap`
  - `getCuttingPlaneData`
  - `getDefaultVisibility`
  - `getExplodeMagnitude`
  - `getFaceVisibility`
  - `getLineVisibility`
  - `getMarkup`
  - `getName`
  - `getSheetId`
  - `getSnapshotImage`
  - `getUniqueId`
  - `getVisibilityExceptions`
  - `removeMarkup`
  - `setColorMap`
  - `setCuttingPlaneData`
  - `setDefaultVisibility`
  - `setExplodeMagnitude`
  - `setFaceVisibility`
  - `setLineVisibility`
  - `setName`
  - `setSnapshotImage`
  - `setVisibilityExceptions`
  - `toJson`

## Methods

`Markup.MarkupView.``addMarkupItem`()
  addMarkupItem(markupItem: `MarkupItem`): void

  Adds a markup item to this view

  Parameters

  > markupItem: `MarkupItem`

  > > the markup to be added to this view.

  Returns: void

`Markup.MarkupView.``getCamera`()
  getCamera(): `Camera`

  Gets the camera of this view

  Returns: `Camera`

  > the camera of this view

`Markup.MarkupView.``getColorMap`()
  getColorMap(): Map

  Returns: Map

  > A color map associating NodeIds to Colors.

`Markup.MarkupView.``getCuttingPlaneData`()
  getCuttingPlaneData(): object

  Returns: object

  > a JSON object with the cutting plane data associated with this view

`Markup.MarkupView.``getDefaultVisibility`()
  getDefaultVisibility(): boolean

  Returns: boolean

`Markup.MarkupView.``getExplodeMagnitude`()
  getExplodeMagnitude(): number

  Returns: number

  > the explode value associated with this view

`Markup.MarkupView.``getFaceVisibility`()
  getFaceVisibility(): boolean

  Gets face visibility setting for this view

  Returns: boolean

  > face visibility setting for this view

`Markup.MarkupView.``getLineVisibility`()
  getLineVisibility(): boolean

  Gets line visibility setting for this view

  Returns: boolean

  > line visibility setting for this view

`Markup.MarkupView.``getMarkup`()
  getMarkup(): `MarkupItem`[]

  Gets an array of markup items associated with this view

  Returns: `MarkupItem`[]

  > face visibility setting for this view

`Markup.MarkupView.``getName`()
  getName(): string

  Gets the name of this view

  Returns: string

  > name of this view

`Markup.MarkupView.``getSheetId`()
  getSheetId(): (None | number)

  Gets the sheet id for this view

  Returns: (None | number)

  > the id of the sheet for this view. If no view was active at the time of creation this function will return null.

`Markup.MarkupView.``getSnapshotImage`()
  getSnapshotImage(): (None | HTMLImageElement)

  Returns: (None | HTMLImageElement)

`Markup.MarkupView.``getUniqueId`()
  getUniqueId(): string

  Gets the unique identifier of this view

  Returns: string

  > unique identifier of this view

`Markup.MarkupView.``getVisibilityExceptions`()
  getVisibilityExceptions(): Set

  Returns: Set

`Markup.MarkupView.``removeMarkup`()
  removeMarkup(item: `MarkupItem`): boolean

  Removes a markup item from the view

  Parameters

  > item: `MarkupItem`

  Returns: boolean

  > result of the removal operation

`Markup.MarkupView.``setColorMap`()
  setColorMap(colorMap: Map): void

  Takes a color map associating NodeIds to Colors and associates it with this view.

  Parameters

  > colorMap: Map

  Returns: void

`Markup.MarkupView.``setCuttingPlaneData`()
  setCuttingPlaneData(cuttingPlaneData: object): void

  Takes a JSON cutting plane data object and associates it with this view

  Parameters

  > cuttingPlaneData: object

  Returns: void

`Markup.MarkupView.``setDefaultVisibility`()
  setDefaultVisibility(defaultVisibility: boolean): void

  Parameters

  > defaultVisibility: boolean

  Returns: void

`Markup.MarkupView.``setExplodeMagnitude`()
  setExplodeMagnitude(explodeMagnitude: number): void

  Takes an explode magnitude and associates it with this view

  Parameters

  > explodeMagnitude: number

  Returns: void

`Markup.MarkupView.``setFaceVisibility`()
  setFaceVisibility(faceVisibility: boolean): void

  Sets face visibility for this view

  Parameters

  > faceVisibility: boolean

  > > face visibility setting for this view

  Returns: void

`Markup.MarkupView.``setLineVisibility`()
  setLineVisibility(lineVisibility: boolean): void

  Sets line visibility for this view

  Parameters

  > lineVisibility: boolean

  > > line visibility setting for this view

  Returns: void

`Markup.MarkupView.``setName`()
  setName(name: string): void

  Sets the name for this view

  Parameters

  > name: string

  > > name to set

  Returns: void

`Markup.MarkupView.``setSnapshotImage`()
  setSnapshotImage(image: HTMLImageElement): void

  Parameters

  > image: HTMLImageElement

  Returns: void

`Markup.MarkupView.``setVisibilityExceptions`()
  setVisibilityExceptions(nodeIds: Set): void

  Parameters

  > nodeIds: Set

  Returns: void

`Markup.MarkupView.``toJson`()
  toJson(): object

  Creates an object ready for JSON serialization.

  Returns: object

  > The prepared object.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...