You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
438 lines
14 KiB
438 lines
14 KiB
/*
|
|
* Copyright (C) 1998-2019 by Northwoods Software Corporation. All Rights Reserved.
|
|
*/
|
|
|
|
import * as go from '../release/go';
|
|
|
|
/**
|
|
* 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:
|
|
* - `alignment` ***Spot*** see {@link #alignment}
|
|
* - `alignmentFocus` ***Spot*** see {@link #alignmentFocus}
|
|
* - `size` ***number*** see {@link #size}
|
|
* - `buttonSize` ***number*** see {@link #buttonSize}
|
|
* - `orientation` ***string*** see {@link #orientation}
|
|
* - `opacity` ***number*** see {@link #opacity}
|
|
*
|
|
* Example usage of ZoomSlider:
|
|
* ```js
|
|
* var 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:
|
|
* ```html
|
|
* <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>
|
|
* ```
|
|
*
|
|
* <p class="box">
|
|
* 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 <a href="../../extensionsTS/ZoomSlider.html">Zoom Slider</a> sample.
|
|
* @category Extension
|
|
*/
|
|
export class ZoomSlider {
|
|
private _diagram: go.Diagram;
|
|
private _initialScale: number;
|
|
private _diagramDiv: HTMLDivElement | null;
|
|
private _sliderDiv: HTMLDivElement | null;
|
|
|
|
// Slider options defaults:
|
|
private _size: number = 125;
|
|
private _buttonSize: number = 25;
|
|
private _alignment: go.Spot = go.Spot.BottomRight;
|
|
private _alignmentFocus: go.Spot = go.Spot.BottomRight;
|
|
private _orientation: string = 'vertical';
|
|
private _opacity: number = .75;
|
|
|
|
// Function used to keep the slider up to date
|
|
private updateOnViewportBoundsChanged: ((e: go.DiagramEvent) => void);
|
|
|
|
/**
|
|
* 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.
|
|
* @param {Diagram} diagram a reference to a GoJS Diagram
|
|
* @param {Object=} options an optional JS Object describing options for the slider
|
|
*/
|
|
constructor(diagram: go.Diagram, options?: { [index: string]: any}) {
|
|
this._diagram = diagram;
|
|
this._initialScale = diagram.scale;
|
|
this._diagramDiv = diagram.div;
|
|
this._sliderDiv = null;
|
|
|
|
// Set properties based on options
|
|
if (options !== undefined) {
|
|
if (options.size !== undefined) this._size = options.size;
|
|
if (options.buttonSize !== undefined) this._buttonSize = options.buttonSize;
|
|
if (options.alignment !== undefined) this._alignment = options.alignment;
|
|
if (options.alignmentFocus !== undefined) this._alignmentFocus = options.alignmentFocus;
|
|
if (options.orientation !== undefined) this._orientation = options.orientation;
|
|
if (options.opacity !== undefined) this._opacity = options.opacity;
|
|
}
|
|
|
|
// Prepare change listeners
|
|
const self = this;
|
|
this.updateOnViewportBoundsChanged = (e: go.DiagramEvent) => { self.scaleToValue(); };
|
|
|
|
this.init();
|
|
}
|
|
|
|
/**
|
|
* This read-only property returns the diagram for which the slider is handling zoom.
|
|
*/
|
|
get diagram(): go.Diagram { return this._diagram; }
|
|
|
|
/**
|
|
* Gets or sets the overall length, in pixels, that the slider will occupy.
|
|
* The default value is 125.
|
|
*/
|
|
get size(): number { return this._size; }
|
|
set size(val: number) {
|
|
const old = this._size;
|
|
if (old !== val) {
|
|
this._size = val;
|
|
this.resize();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets or sets the height/width of the buttons at each end of the slider.
|
|
* The default value is 25.
|
|
*/
|
|
get buttonSize(): number { return this._buttonSize; }
|
|
set buttonSize(val: number) {
|
|
const old = this._buttonSize;
|
|
if (old !== val) {
|
|
this._buttonSize = val;
|
|
this.resize();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
get alignment(): go.Spot { return this._alignment; }
|
|
set alignment(val: go.Spot) {
|
|
const old = this._alignment;
|
|
if (old !== val) {
|
|
this._alignment = val;
|
|
this.realign();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
get alignmentFocus(): go.Spot { return this._alignmentFocus; }
|
|
set alignmentFocus(val: go.Spot) {
|
|
const old = this._alignmentFocus;
|
|
if (old !== val) {
|
|
this._alignmentFocus = val;
|
|
this.realign();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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"`.
|
|
*/
|
|
get orientation(): string { return this._orientation; }
|
|
set orientation(val: string) {
|
|
if (val !== 'horizontal' && val !== 'vertical') {
|
|
throw new Error('Orientation must be "horizontal" or "vertical"');
|
|
}
|
|
const old = this._orientation;
|
|
if (old !== val) {
|
|
this._orientation = val;
|
|
this.resize(true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets or sets the opacity of the slider.
|
|
* The default value is 0.75.
|
|
*/
|
|
get opacity(): number { return this._opacity; }
|
|
set opacity(val: number) {
|
|
const old = this._opacity;
|
|
if (old !== val) {
|
|
this._opacity = val;
|
|
if (this._sliderDiv !== null) {
|
|
this._sliderDiv.style.opacity = val.toString();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Initialize the slider.
|
|
*/
|
|
private init() {
|
|
// Sets up the slider div and inner div's basic attributes and ids
|
|
this.sliderDivSetup();
|
|
this.resize(true);
|
|
|
|
// Set up the runtime code
|
|
this.sliderListenerSetup();
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Create the necessary divs for the slider and add the slider as a sibling of the diagram.
|
|
*/
|
|
private sliderDivSetup() {
|
|
this._sliderDiv = document.createElement('div');
|
|
this._sliderDiv.className = 'zoomSlider';
|
|
|
|
// Initialize buttons and range input
|
|
const zoomOutBtn = document.createElement('button');
|
|
zoomOutBtn.id = 'zoomSliderOut';
|
|
zoomOutBtn.className = 'zoomButton';
|
|
zoomOutBtn.innerHTML = '-';
|
|
this._sliderDiv.appendChild(zoomOutBtn);
|
|
|
|
const zoomRangeContainer = document.createElement('div');
|
|
zoomRangeContainer.id = 'zoomSliderRangeCtn';
|
|
zoomRangeContainer.className = 'zoomRangeContainer';
|
|
this._sliderDiv.appendChild(zoomRangeContainer);
|
|
|
|
const zoomRangeInput = document.createElement('input');
|
|
zoomRangeInput.id = 'zoomSliderRange';
|
|
zoomRangeInput.className = 'zoomRangeInput';
|
|
zoomRangeInput.type = 'range';
|
|
zoomRangeInput.min = '-50';
|
|
zoomRangeInput.max = '100';
|
|
zoomRangeContainer.appendChild(zoomRangeInput);
|
|
|
|
const zoomInBtn = document.createElement('button');
|
|
zoomInBtn.id = 'zoomSliderIn';
|
|
zoomInBtn.className = 'zoomButton';
|
|
zoomInBtn.innerHTML = '+';
|
|
this._sliderDiv.appendChild(zoomInBtn);
|
|
|
|
// Adds the slider as a sibling of the diagram
|
|
// IMPORTANT: the diagram div's parent element should use position: relative
|
|
if (this._diagramDiv !== null) {
|
|
const diagramParent = this._diagramDiv.parentElement;
|
|
if (diagramParent !== null) {
|
|
diagramParent.appendChild(this._sliderDiv);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Add listeners to the buttons and range input.
|
|
* Add a diagram listener.
|
|
*/
|
|
private sliderListenerSetup() {
|
|
const zoomOutBtn = document.getElementById('zoomSliderOut');
|
|
const zoomInBtn = document.getElementById('zoomSliderIn');
|
|
const zoomRangeInput = document.getElementById('zoomSliderRange') as HTMLInputElement;
|
|
|
|
if (zoomOutBtn === null || zoomInBtn === null || zoomRangeInput === null) return;
|
|
|
|
// Set up diagram listener so the slider can be kept in sync with the diagram's scale
|
|
this.diagram.addDiagramListener('ViewportBoundsChanged', this.updateOnViewportBoundsChanged);
|
|
|
|
// Set up event handlers for buttons and input range slider
|
|
const self = this;
|
|
zoomOutBtn.onclick = function() {
|
|
zoomRangeInput.stepDown();
|
|
self.valueToScale();
|
|
};
|
|
|
|
zoomInBtn.onclick = function() {
|
|
zoomRangeInput.stepUp();
|
|
self.valueToScale();
|
|
};
|
|
|
|
const valChanged = function() {
|
|
self.valueToScale();
|
|
};
|
|
zoomRangeInput.oninput = valChanged;
|
|
zoomRangeInput.onchange = valChanged;
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Resize the slider.
|
|
* @param {boolean=} reorient whether or not to reorient the slider/buttons
|
|
*/
|
|
private resize(reorient?: boolean) {
|
|
let sliderWidth = 0;
|
|
let sliderHeight = 0;
|
|
|
|
const zoomOutBtn = document.getElementById('zoomSliderOut');
|
|
const zoomInBtn = document.getElementById('zoomSliderIn');
|
|
const zoomRangeContainer = document.getElementById('zoomSliderRangeCtn');
|
|
const zoomRangeInput = document.getElementById('zoomSliderRange');
|
|
|
|
if (this._sliderDiv === null || zoomOutBtn === null || zoomInBtn === null ||
|
|
zoomRangeContainer === null || zoomRangeInput === null) return;
|
|
|
|
if (this.orientation === 'horizontal') {
|
|
sliderWidth = this.size;
|
|
sliderHeight = this.buttonSize;
|
|
const rangeWidth = sliderWidth - sliderHeight * 2;
|
|
|
|
zoomOutBtn.style.width = sliderHeight + 'px';
|
|
zoomOutBtn.style.height = sliderHeight + 'px';
|
|
|
|
zoomRangeContainer.style.width = rangeWidth + 'px';
|
|
zoomRangeContainer.style.height = sliderHeight + 'px';
|
|
|
|
zoomRangeInput.style.width = rangeWidth + 'px';
|
|
zoomRangeInput.style.height = sliderHeight + 'px';
|
|
zoomRangeInput.style.transformOrigin = null;
|
|
|
|
zoomInBtn.style.width = sliderHeight + 'px';
|
|
zoomInBtn.style.height = sliderHeight + 'px';
|
|
} else {
|
|
sliderHeight = this.size;
|
|
sliderWidth = this.buttonSize;
|
|
const rangeHeight = sliderHeight - sliderWidth * 2;
|
|
|
|
zoomInBtn.style.width = sliderWidth + 'px';
|
|
zoomInBtn.style.height = sliderWidth + 'px';
|
|
|
|
zoomRangeContainer.style.width = sliderWidth + 'px';
|
|
zoomRangeContainer.style.height = rangeHeight + 'px';
|
|
|
|
zoomRangeInput.style.width = rangeHeight + 'px';
|
|
zoomRangeInput.style.height = sliderWidth + 'px';
|
|
zoomRangeInput.style.transformOrigin = rangeHeight / 2 + 'px ' + rangeHeight / 2 + 'px';
|
|
|
|
zoomOutBtn.style.width = sliderWidth + 'px';
|
|
zoomOutBtn.style.height = sliderWidth + 'px';
|
|
}
|
|
this._sliderDiv.style.width = sliderWidth + 'px';
|
|
this._sliderDiv.style.height = sliderHeight + 'px';
|
|
|
|
// Reorient the slider, if necessary
|
|
if (reorient) {
|
|
this.reorient();
|
|
}
|
|
|
|
// Realign based on new size
|
|
this.realign();
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Reorient the slider, changing the transform and the order of the buttons within the div.
|
|
*/
|
|
private reorient() {
|
|
const zoomOutBtn = document.getElementById('zoomSliderOut');
|
|
const zoomInBtn = document.getElementById('zoomSliderIn');
|
|
const zoomRangeInput = document.getElementById('zoomSliderRange');
|
|
|
|
if (this._sliderDiv === null || zoomOutBtn === null || zoomInBtn === null || zoomRangeInput === null) return;
|
|
|
|
// Need to set the transform of the range input and move the buttons to the correct sides
|
|
if (this.orientation === 'horizontal') {
|
|
zoomRangeInput.style.transform = null;
|
|
this._sliderDiv.insertBefore(zoomOutBtn, this._sliderDiv.firstChild);
|
|
this._sliderDiv.appendChild(zoomInBtn);
|
|
} else {
|
|
zoomRangeInput.style.transform = 'rotate(-90deg)';
|
|
this._sliderDiv.insertBefore(zoomInBtn, this._sliderDiv.firstChild);
|
|
this._sliderDiv.appendChild(zoomOutBtn);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Realigns to slider relative to the diagram.
|
|
*/
|
|
private realign() {
|
|
if (this._diagramDiv === null || this._sliderDiv === null) return;
|
|
|
|
let sliderWidth = 0;
|
|
let sliderHeight = 0;
|
|
if (this.orientation === 'horizontal') {
|
|
sliderWidth = this.size;
|
|
sliderHeight = this.buttonSize;
|
|
} else {
|
|
sliderHeight = this.size;
|
|
sliderWidth = this.buttonSize;
|
|
}
|
|
|
|
// Finds the diagram and diagram's parent in the page
|
|
const diagramParent = this._diagramDiv.parentElement;
|
|
const diagramLoc = this._diagramDiv.getBoundingClientRect();
|
|
if (diagramParent !== null) {
|
|
const parentLoc = diagramParent.getBoundingClientRect();
|
|
|
|
const top = diagramLoc.top - parentLoc.top +
|
|
this.alignment.y * this._diagramDiv.clientHeight + this.alignment.offsetY -
|
|
this.alignmentFocus.y * sliderHeight + this.alignmentFocus.offsetY;
|
|
|
|
const left = diagramLoc.left - parentLoc.left +
|
|
this.alignment.x * this._diagramDiv.clientWidth + this.alignment.offsetX -
|
|
this.alignmentFocus.x * sliderWidth + this.alignmentFocus.offsetX;
|
|
|
|
this._sliderDiv.style.top = top + 'px';
|
|
this._sliderDiv.style.left = left + 'px';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Update the value of the slider input to match the diagram's scale.
|
|
*/
|
|
private scaleToValue() {
|
|
const slider = document.getElementById('zoomSliderRange') as HTMLInputElement;
|
|
const diagram = this.diagram;
|
|
const A = this._initialScale;
|
|
const B = diagram.commandHandler.zoomFactor;
|
|
const y1 = diagram.scale;
|
|
slider.value = Math.round(Math.log(y1 / A) / Math.log(B)).toString();
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* Update the diagram's scale to match the value of the slider input.
|
|
*/
|
|
private valueToScale() {
|
|
const slider = document.getElementById('zoomSliderRange') as HTMLInputElement;
|
|
const diagram = this.diagram;
|
|
const x = parseFloat(slider.value);
|
|
const A = this._initialScale;
|
|
const B = diagram.commandHandler.zoomFactor;
|
|
diagram.scale = A * Math.pow(B, x);
|
|
}
|
|
|
|
/**
|
|
* Remove the slider from the page.
|
|
*/
|
|
public remove() {
|
|
// Remove the listener attached to diagram
|
|
this.diagram.removeDiagramListener('ViewportBoundsChanged', this.updateOnViewportBoundsChanged);
|
|
|
|
if (this._sliderDiv !== null) {
|
|
this._sliderDiv.innerHTML = '';
|
|
if (this._sliderDiv.parentElement) {
|
|
this._sliderDiv.parentElement.removeChild(this._sliderDiv);
|
|
}
|
|
this._sliderDiv = null;
|
|
}
|
|
}
|
|
}
|