refactor(core): remove waiting for dimensions in zoom pan helper

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
braks
2023-02-22 20:20:11 +01:00
committed by Braks
parent 74f2596f80
commit d2c6b592f5
2 changed files with 14 additions and 68 deletions
@@ -1,5 +1,5 @@
import { zoomIdentity } from 'd3-zoom' import { zoomIdentity } from 'd3-zoom'
import type { D3Selection, Dimensions, GraphNode, ViewportFunctions } from '~/types' import type { D3Selection, GraphNode, ViewportFunctions } from '~/types'
const DEFAULT_PADDING = 0.1 const DEFAULT_PADDING = 0.1
@@ -7,24 +7,8 @@ const DEFAULT_PADDING = 0.1
* @deprecated use {@link useVueFlow} instead (all viewport functions are also available in {@link useVueFlow}) * @deprecated use {@link useVueFlow} instead (all viewport functions are also available in {@link useVueFlow})
*/ */
export default (vueFlowId?: string): ViewportFunctions => { export default (vueFlowId?: string): ViewportFunctions => {
const { const { nodes, d3Zoom, d3Selection, dimensions, translateExtent, minZoom, maxZoom, viewport, snapToGrid, snapGrid, getNodes } =
nodes, $(useVueFlow({ id: vueFlowId }))
d3Zoom,
d3Selection,
dimensions,
translateExtent,
minZoom,
maxZoom,
viewport,
snapToGrid,
snapGrid,
getNodes,
onPaneReady,
} = $(useVueFlow({ id: vueFlowId }))
let hasDimensions = $ref(false)
onPaneReady(() => (hasDimensions = true))
return { return {
zoomIn: async (options) => { zoomIn: async (options) => {
@@ -34,14 +18,11 @@ export default (vueFlowId?: string): ViewportFunctions => {
await zoom(1 / 1.2, options?.duration) await zoom(1 / 1.2, options?.duration)
}, },
zoomTo: async (zoomLevel, options) => { zoomTo: async (zoomLevel, options) => {
if (!hasDimensions) await untilDimensions(dimensions, getNodes)
if (d3Selection && d3Zoom) { if (d3Selection && d3Zoom) {
d3Zoom.scaleTo(transition(d3Selection, options?.duration), zoomLevel) d3Zoom.scaleTo(transition(d3Selection, options?.duration), zoomLevel)
} }
}, },
setTransform: async (transform, options) => { setTransform: async (transform, options) => {
if (!hasDimensions) await untilDimensions(dimensions, getNodes)
transformViewport(transform.x, transform.y, transform.zoom, options?.duration) transformViewport(transform.x, transform.y, transform.zoom, options?.duration)
}, },
getTransform: () => ({ getTransform: () => ({
@@ -56,8 +37,6 @@ export default (vueFlowId?: string): ViewportFunctions => {
duration: 0, duration: 0,
}, },
) => { ) => {
if (!hasDimensions) await untilDimensions(dimensions, getNodes)
if (!nodes.length) return if (!nodes.length) return
const nodesToFit: GraphNode[] = (options.includeHiddenNodes ? nodes : getNodes).filter((node) => { const nodesToFit: GraphNode[] = (options.includeHiddenNodes ? nodes : getNodes).filter((node) => {
@@ -86,8 +65,6 @@ export default (vueFlowId?: string): ViewportFunctions => {
transformViewport(x, y, zoom, options?.duration) transformViewport(x, y, zoom, options?.duration)
}, },
setCenter: async (x, y, options) => { setCenter: async (x, y, options) => {
if (!hasDimensions) await untilDimensions(dimensions, getNodes)
const nextZoom = typeof options?.zoom !== 'undefined' ? options.zoom : maxZoom const nextZoom = typeof options?.zoom !== 'undefined' ? options.zoom : maxZoom
const centerX = dimensions.width / 2 - x * nextZoom const centerX = dimensions.width / 2 - x * nextZoom
const centerY = dimensions.height / 2 - y * nextZoom const centerY = dimensions.height / 2 - y * nextZoom
@@ -95,8 +72,6 @@ export default (vueFlowId?: string): ViewportFunctions => {
transformViewport(centerX, centerY, nextZoom, options?.duration) transformViewport(centerX, centerY, nextZoom, options?.duration)
}, },
fitBounds: async (bounds, options = { padding: DEFAULT_PADDING }) => { fitBounds: async (bounds, options = { padding: DEFAULT_PADDING }) => {
if (!hasDimensions) await untilDimensions(dimensions, getNodes)
const { x, y, zoom } = getTransformForBounds(bounds, dimensions.width, dimensions.height, minZoom, maxZoom, options.padding) const { x, y, zoom } = getTransformForBounds(bounds, dimensions.width, dimensions.height, minZoom, maxZoom, options.padding)
transformViewport(x, y, zoom, options?.duration) transformViewport(x, y, zoom, options?.duration)
@@ -105,8 +80,6 @@ export default (vueFlowId?: string): ViewportFunctions => {
} }
async function zoom(scale: number, duration?: number) { async function zoom(scale: number, duration?: number) {
if (!hasDimensions) await untilDimensions(dimensions, getNodes)
if (d3Selection && d3Zoom) { if (d3Selection && d3Zoom) {
d3Zoom.scaleBy(transition(d3Selection, duration), scale) d3Zoom.scaleBy(transition(d3Selection, duration), scale)
} }
@@ -127,16 +100,3 @@ export default (vueFlowId?: string): ViewportFunctions => {
function transition(selection: D3Selection, ms = 0) { function transition(selection: D3Selection, ms = 0) {
return selection.transition().duration(ms) return selection.transition().duration(ms)
} }
async function untilDimensions(dimensions: Dimensions, nodes: GraphNode[]) {
// if ssr we can't wait for dimensions, they'll never really exist
const window = useWindow()
if ('screen' in window) {
// if initial nodes are present, wait until the node dimensions have been established
if (nodes.length > 0) {
await until(nodes).toMatch((nodes) => nodes.filter((node) => node.initialized).length === nodes.length, { flush: 'pre' })
}
}
return true
}
@@ -1,42 +1,28 @@
<script lang="ts" setup> <script lang="ts" setup>
import NodeRenderer from '../NodeRenderer/NodeRenderer.vue' import NodeRenderer from '../NodeRenderer/NodeRenderer.vue'
import EdgeRenderer from '../EdgeRenderer/EdgeRenderer.vue' import EdgeRenderer from '../EdgeRenderer/EdgeRenderer.vue'
import type { Dimensions } from '../../types'
const { id, viewport, dimensions, emits, onNodesInitialized, ...rest } = useVueFlow() const { id, viewport, emits, onNodesInitialized, ...rest } = useVueFlow()
const untilDimensions = async (dim: Dimensions) => {
// if ssr we can't wait for dimensions, they'll never really exist
const window = useWindow()
if ('screen' in window) {
// wait until viewport dimensions has been established
await until(dim).toMatch(({ height, width }) => !isNaN(width) && width > 0 && !isNaN(height) && height > 0)
}
return true
}
let isReady = $ref(false) let isReady = $ref(false)
onNodesInitialized(() => { onNodesInitialized(() => {
setTimeout(() => { setTimeout(() => {
// hide graph until nodes are ready, so we don't have jumping graphs (ssr for example) // hide graph until nodes are ready, so we don't have jumping nodes
isReady = true isReady = true
}, 0) }, 0)
}) })
onMounted(async () => { onMounted(async () => {
// wait until proper dimensions have been established, otherwise fitView will have wrong bounds when called at paneReady setTimeout(() => {
await untilDimensions(dimensions.value) emits.paneReady({
id,
emits.paneReady({ viewport,
id, emits,
viewport, onNodesInitialized,
dimensions, ...rest,
emits, })
onNodesInitialized, }, 1)
...rest,
})
}) })
</script> </script>