Class DiagramViewer

constructor

• new DiagramViewer(): DiagramViewer

• Creates a new instance of the Diagram Viewer.

  Returns DiagramViewer

Readonly settings

zoomSteps

autoScaling

• get autoScaling(): AutoScaleDirection

• Configures auto-scaling behavior.

  • none - no auto-scaling
  • down (default) - auto-scales the diagram down when it doesn't fit into the control
  • up - auto-scales the diagram to the largest size fitting into the control but not smaller than 100%
  • both - keeps diagram at maximum size that fits into the control

  Since

  1.1.0

  Returns AutoScaleDirection

• set autoScaling(value): void

• Parameters

  • value: AutoScaleDirection

  Returns void

loadAnimationEnabled

• get loadAnimationEnabled(): boolean

• Returns whether diagram stencils should fade in after loading

  Since

  1.2.0

  Returns boolean

• set loadAnimationEnabled(value): void

• Sets whether diagram stencils should fade in after loading

  Since

  1.2.0

  Parameters

  • value: boolean

  Returns void

stencilSet

• get stencilSet(): StencilSet

• Returns currently active StencilSet.

  Returns StencilSet

• set stencilSet(value): void

• Sets current StencilSet.

  Parameters

  • value: StencilSet

  Returns void

toolbarVisible

• get toolbarVisible(): boolean

• Returns whether toolbar is visible (enabled)

  Since

  1.2.0

  Returns boolean

• set toolbarVisible(value): void

• Sets whether toolbar is visible (enabled)

  Since

  1.2.0

  Parameters

  • value: boolean

  Returns void

zoomLevel

• get zoomLevel(): number

• Gets the current zoom level of the control (1 is 100%).

  Returns number

• set zoomLevel(value): void

• Set the zoom level of the contrl (1 is 100%).

  Parameters

  • value: number

  Returns void

addEventListener

• addEventListener<T>(type, listener, options?): void

• Type Parameters

  • T extends keyof DiagramViewerEventMap

  Parameters

  • type: T

  • listener: ((this, ev) => void)

    • • (this, ev): void

      • Parameters

        • this: DiagramViewer

        • ev: DiagramViewerEventMap[T]

        Returns void

  • Optional options: boolean | AddEventListenerOptions

  Returns void

• addEventListener<K>(type, listener, options?): void

• Type Parameters

  • K extends keyof HTMLElementEventMap

  Parameters

  • type: K

  • listener: ((this, ev) => void)

    • • (this, ev): void

      • Parameters

        • this: HTMLElement

        • ev: HTMLElementEventMap[K]

        Returns void

  • Optional options: boolean | AddEventListenerOptions

  Returns void

autoScale

• autoScale(): void

• Scales the diagram inside the viewer according to the autoScaling setting.

  Since

  1.1.0

  Returns void

getNewIId

• getNewIId(): number

• Returns a new internal object identifier.

  Returns number

removeEventListener

• removeEventListener<T>(type, listener, options?): void

• Type Parameters

  • T extends keyof DiagramViewerEventMap

  Parameters

  • type: T

  • listener: ((this, ev) => void)

    • • (this, ev): void

      • Parameters

        • this: DiagramViewer

        • ev: DiagramViewerEventMap[T]

        Returns void

  • Optional options: boolean | EventListenerOptions

  Returns void

• removeEventListener<K>(type, listener, options?): void

• Type Parameters

  • K extends keyof HTMLElementEventMap

  Parameters

  • type: K

  • listener: ((this, ev) => void)

    • • (this, ev): void

      • Parameters

        • this: HTMLElement

        • ev: HTMLElementEventMap[K]

        Returns void

  • Optional options: boolean | EventListenerOptions

  Returns void

show

• show(state): void

• Displays a previously saved diagram.

  Remarks

  Make sure to set the correct corresponding stencilSet before calling show().

  Parameters

  • state: DiagramState

    diagram configration object.

  Returns void

zoom

• zoom(factor): void

• Zooms in or out to the supplied zoom level (1 = 100%).

  Parameters

  • factor: number

    zoom level.

  Returns void