IBM ILOG Dojo Diagrammer 1.1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.diagram.overview

Object » ibm_ilog.diagram.overview

Property Summary

  • OverviewInteractorMixin Abstract class with the basic behavior of an interactor which handles input into an Overview.

Method Summary

  • Overview(viewport, content, renderer, output, size) Draws the overview as a GFX group. architecture: The overview is a mini-diagram with no zooming or panning options that always shows the entire diagram, like a map. An Overview object draws a map-like representation of the contents of a viewport. It can be used through the OverviewWidget or directly (for example for using it to draw a component of the Viewport HUD). An Overview relies on an OverviewRenderer which encapsulates the algorithm for generating the overview image. Different algorithms provide different representation. view rectangle: The Overview also represents the current location of the Viewport with a GFX Rectangle. Whenever the viewport is repositioned or zoomed, the Viewport object will notify the event, to which the Overview will react updating a rectangle shape. navigation: See pointers on how the user could interact with the Overview, see the subclasses of OverviewInteractor and how the Overview widget uses them.
  • OverviewGfxRenderer(diagram)
  • OverviewInteractor()
  • OverviewPanInteractor() An OverviewPanInteractor pans the viewport when the user drags on the overview and centers the viewport on a point when the user clicks at that point. //
  • OverviewRenderer() The abstract superclass of overview renderers. This class may only exist for documentation purposes only.
  • OverviewTemplateRenderer(kwArgs) Uses custom templates to generate the overview image.
  • OverviewTopLevelTemplateRenderer(kwArgs) Uses custom templates to generate the overview image.
  • OverviewWidget() A widget that shows the overview of a Diagram. markup example: <div dojoType="ibm_ilog.diagram.widget.Diagram" jsId="myDiagram"></div> <div dojoType="ibm_ilog.diagram.overview.OverviewWidget" diagram="myDiagram"></div> markup example (custom renderer): <div dojoType="ibm_ilog.diagram.widget.Diagram" jsId="myDiagram"></div> <div dojoType="ibm_ilog.diagram.overview.OverviewTemplateRenderer" graph="myDiagram.getGraph()" node="myNodeTemplate" jsId="renderer"></div> <div dojoType="ibm_ilog.diagram.overview.OverviewWidget" diagram="myDiagram" renderer="renderer"></div>
  • OverviewZoomInteractor() A ZoomInteractor controls the process of viewport panning and zooming

Attached Objects

Properties

OverviewInteractorMixin
Abstract class with the basic behavior of an interactor which handles input into an Overview.

Methods

Overview
Draws the overview as a GFX group. architecture: The overview is a mini-diagram with no zooming or panning options that always shows the entire diagram, like a map. An Overview object draws a map-like representation of the contents of a viewport. It can be used through the OverviewWidget or directly (for example for using it to draw a component of the Viewport HUD). An Overview relies on an OverviewRenderer which encapsulates the algorithm for generating the overview image. Different algorithms provide different representation. view rectangle: The Overview also represents the current location of the Viewport with a GFX Rectangle. Whenever the viewport is repositioned or zoomed, the Viewport object will notify the event, to which the Overview will react updating a rectangle shape. navigation: See pointers on how the user could interact with the Overview, see the subclasses of OverviewInteractor and how the Overview widget uses them.
ParameterTypeDescription
viewportibm_ilog.diagram.widget.Viewport
contentObject
rendereribm_ilog.diagram.overview.OverviewRenderer
outputdojox.gfx.Group
sizeSize
OverviewGfxRenderer
ParameterTypeDescription
diagramibm_ilog.diagram.widget.Diagram
OverviewInteractor
OverviewPanInteractor
An OverviewPanInteractor pans the viewport when the user drags on the overview and centers the viewport on a point when the user clicks at that point. //
OverviewRenderer
The abstract superclass of overview renderers. This class may only exist for documentation purposes only.
OverviewTemplateRenderer

Iterates the given graph and reinstantiates the elements in the graph with new templates. If no templates are specified, default ones are used.

ParameterTypeDescription
kwArgs
OverviewTopLevelTemplateRenderer

Iterates the given graph and reinstantiates the elements in the graph with new templates. If no templates are specified, default ones are used.

ParameterTypeDescription
kwArgs
OverviewWidget
A widget that shows the overview of a Diagram. markup example: <div dojoType="ibm_ilog.diagram.widget.Diagram" jsId="myDiagram"></div> <div dojoType="ibm_ilog.diagram.overview.OverviewWidget" diagram="myDiagram"></div> markup example (custom renderer): <div dojoType="ibm_ilog.diagram.widget.Diagram" jsId="myDiagram"></div> <div dojoType="ibm_ilog.diagram.overview.OverviewTemplateRenderer" graph="myDiagram.getGraph()" node="myNodeTemplate" jsId="renderer"></div> <div dojoType="ibm_ilog.diagram.overview.OverviewWidget" diagram="myDiagram" renderer="renderer"></div>
OverviewZoomInteractor
A ZoomInteractor controls the process of viewport panning and zooming