Communicator.Markup.MarkupView

 MarkupView

Methods

addMarkupItem

  • Adds a markup item to this view

    Parameters

    • markupItem: MarkupItem

      the markup to be added to this view.

    Returns void

forJson    [deprecated]

  • forJson(): Object
  • deprecated

    Use toJson instead.

    Returns Object

getCamera

  • Gets the camera of this view

    Returns Camera

    the camera of this view

getColorMap

  • Returns Map<NodeId, Color>

    A color map associating NodeIds to Colors.

getCuttingPlaneData

  • getCuttingPlaneData(): Object
  • Returns Object

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

getDefaultVisibility

  • getDefaultVisibility(): boolean
  • Returns boolean

getExplodeMagnitude

  • getExplodeMagnitude(): number
  • Returns number

    the explode value associated with this view

getFaceVisibility

  • getFaceVisibility(): boolean
  • Gets face visibility setting for this view

    Returns boolean

    face visibility setting for this view

getLineVisibility

  • getLineVisibility(): boolean
  • Gets line visibility setting for this view

    Returns boolean

    line visibility setting for this view

getMarkup

  • getMarkup(): MarkupItem[]
  • Gets an array of markup items associated with this view

    Returns MarkupItem[]

    face visibility setting for this view

getName

  • getName(): string
  • Gets the name of this view

    Returns string

    name of this view

getSheetId

  • Gets the sheet id for this view

    Returns SheetId | null

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

getSnapshotImage

  • getSnapshotImage(): HTMLImageElement | null
  • Returns HTMLImageElement | null

getUniqueId

  • getUniqueId(): Uuid
  • Gets the unique identifier of this view

    Returns Uuid

    unique identifier of this view

getVisibilityExceptions

  • getVisibilityExceptions(): Set<NodeId>

removeMarkup

  • Removes a markup item from the view

    Parameters

    Returns boolean

    result of the removal operation

setColorMap

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

    Parameters

    Returns void

setCuttingPlaneData

  • setCuttingPlaneData(cuttingPlaneData: Object): void
  • Takes a JSON cutting plane data object and associates it with this view

    Parameters

    • cuttingPlaneData: Object

    Returns void

setDefaultVisibility

  • setDefaultVisibility(defaultVisibility: boolean): void
  • Parameters

    • defaultVisibility: boolean

    Returns void

setExplodeMagnitude

  • setExplodeMagnitude(explodeMagnitude: number): void
  • Takes an explode magnitude and associates it with this view

    Parameters

    • explodeMagnitude: number

    Returns void

setFaceVisibility

  • setFaceVisibility(faceVisibility: boolean): void
  • Sets face visibility for this view

    Parameters

    • faceVisibility: boolean

      face visibility setting for this view

    Returns void

setLineVisibility

  • setLineVisibility(lineVisibility: boolean): void
  • Sets line visibility for this view

    Parameters

    • lineVisibility: boolean

      line visibility setting for this view

    Returns void

setName

  • setName(name: string): void
  • Sets the name for this view

    Parameters

    • name: string

      name to set

    Returns void

setSnapshotImage

  • setSnapshotImage(image: HTMLImageElement): void
  • Parameters

    • image: HTMLImageElement

    Returns void

setVisibilityExceptions

  • setVisibilityExceptions(nodeIds: Set<NodeId>): void
  • Parameters

    Returns void

toJson

  • toJson(): Object
  • Creates an object ready for JSON serialization.

    Returns Object

    The prepared object.