GoJS API
/ to search
    Preparing search index...

    Class ZoomSlider

    This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. See the Extensions intro page for more information.

    This class implements a zoom slider for GoJS diagrams. The constructor takes two arguments:

    • diagram Diagram a reference to a GoJS Diagram
    • options Object an optional JS Object describing options for the slider

    Options:

    Example usage of ZoomSlider:

    const zoomSlider = new ZoomSlider(myDiagram,
    {
    alignment: go.Spot.TopRight, alignmentFocus: go.Spot.TopRight,
    size: 150, buttonSize: 30, orientation: 'horizontal'
    });

    This is the basic HTML Structure that the ZoomSlider creates as a sibling div of the diagram:

    <div class="zoomSlider">
    <button id="zoomSliderOut" class="zoomButton">-</button>
    <div id="zoomSliderRangeCtn" class="zoomRangeContainer">
    <input id="zoomSliderRange" class="zoomRangeInput" type="range" min="-50" max="100">
    </div>
    <button id="zoomSliderIn" class="zoomButton">+</button>
    </div>

    The diagram div's parent element should use `position: relative` to ensure the slider gets positioned properly.

    If you want to experiment with this extension, try the Zoom Slider sample.

    Index

    Constructors

    • Constructs a ZoomSlider and sets up properties based on the options provided. Also sets up change listeners on the Diagram so the ZoomSlider stays up-to-date.

      Parameters

      • diagram: Diagram

        a reference to a GoJS Diagram

      • Optionaloptions: { [index: string]: any }

        an optional JS Object describing options for the slider

      Returns ZoomSlider

    Accessors

    • get alignment(): Spot

      Gets or sets the alignment Spot of this slider to determine where it should be placed relative to the diagram. The default value is Spot.BottomRight.

      Returns Spot

    • get alignmentFocus(): Spot

      Gets or sets the Spot on this slider to be used as the alignment point when placing it relative to the diagram. The default value is Spot.BottomRight.

      Returns Spot

    • get buttonSize(): number

      Gets or sets the height/width of the buttons at each end of the slider. The default value is 25.

      Returns number

    • get diagram(): Diagram

      This read-only property returns the diagram for which the slider is handling zoom.

      Returns Diagram

    • get opacity(): number

      Gets or sets the opacity of the slider. The default value is 0.75.

      Returns number

    • get orientation(): string

      Gets or sets whether the slider is oriented vertically or horizontally. Must be either "horizontal" or "vertical" and is case-sensitive. The default value is "vertical".

      Returns string

    • get size(): number

      Gets or sets the overall length, in pixels, that the slider will occupy. The default value is 125.

      Returns number

    Methods

    • Remove the slider from the page.

      Returns void