Skip to content

feat(chart) Make interactions optional (true by default as it was) #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vekkele wants to merge 1 commit into
base: next
Choose a base branch
from
Open

feat(chart) Make interactions optional (true by default as it was) #521

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 42 additions & 15 deletions src/lib/ui/app/Chart/Chart.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
import { useShiftModeStartPoint } from './PaneLegend/ctx.svelte.js'

type TRangeSelectHandler = Parameters<typeof createRangeSelection>[1]['onRangeSelectChange']
type TInteractionFeatures = {
modeShortcuts?: boolean
rangeSelection?: boolean
doubleClickReset?: boolean
}

type TProps = {
/**
* DRAG, SHIFT, ZOOM
Expand All @@ -27,8 +33,9 @@
watermark?: boolean
watermarkOpacity?: string
options?: Parameters<typeof createChart>[1]
onRangeSelectChange: TRangeSelectHandler
onRangeSelectEnd: TRangeSelectHandler
interactionFeatures?: false | TInteractionFeatures
onRangeSelectChange?: TRangeSelectHandler
onRangeSelectEnd?: TRangeSelectHandler
children: Snippet
}
let {
Expand All @@ -37,6 +44,7 @@
watermark = true,
watermarkOpacity,
options,
interactionFeatures = {},
onRangeSelectChange,
onRangeSelectEnd,
children,
Expand All @@ -54,8 +62,13 @@

const theme = $derived((ui.$$.isNightMode, getTheme(watermarkOpacity)))

useChartModeShortcut('SHIFT', Mode.SHIFT)
useChartModeShortcut('CMD', Mode.ZOOM)
if (
isInteractionFeatureEnabled('modeShortcuts') &&
isInteractionFeatureEnabled('rangeSelection')
) {
useChartModeShortcut('SHIFT', Mode.SHIFT)
useChartModeShortcut('CMD', Mode.ZOOM)
}

onMount(() => {
chart.$ = createChart(chartContainerNode, {
Expand All @@ -77,23 +90,31 @@
textWatermark = createPathWatermark(firstPane, { color: theme.watermark })
}

createRangeSelection(chart.$!, {
color: '#9faac435',
onRangeSelectChange: _onRangeSelectChange,
onRangeSelectEnd: _onRangeSelectEnd,
axisLabels: {
textColor: getBrowserCssVariable('white'),
bg: getBrowserCssVariable('waterloo'),
},
})
const rangeSelection = isInteractionFeatureEnabled('rangeSelection')
? createRangeSelection(chart.$!, {
color: '#9faac435',
onRangeSelectChange: _onRangeSelectChange,
onRangeSelectEnd: _onRangeSelectEnd,
axisLabels: {
textColor: getBrowserCssVariable('white'),
bg: getBrowserCssVariable('waterloo'),
},
})
: null

const resetScalesOnDblClick = () => chart.$?.resetAllScales()
chart.$.subscribeDblClick(resetScalesOnDblClick)
const isDoubleClickResetEnabled = isInteractionFeatureEnabled('doubleClickReset')
if (isDoubleClickResetEnabled) {
chart.$.subscribeDblClick(resetScalesOnDblClick)
}

return () => {
if (!chart.$) return

chart.$.unsubscribeDblClick(resetScalesOnDblClick)
rangeSelection?.detach()
if (isDoubleClickResetEnabled) {
chart.$.unsubscribeDblClick(resetScalesOnDblClick)
}
chart.$.remove()
chart.$ = undefined
}
Expand Down Expand Up @@ -130,6 +151,8 @@
})

onMount(() => {
if (!isInteractionFeatureEnabled('modeShortcuts')) return

window.addEventListener('blur', resetChartInteractionMode)
return () => window.removeEventListener('blur', resetChartInteractionMode)
})
Expand Down Expand Up @@ -196,6 +219,10 @@
mode = Mode.DRAG
startPointIndex.$ = null
}

function isInteractionFeatureEnabled(feature: keyof TInteractionFeatures) {
return interactionFeatures !== false && interactionFeatures[feature] !== false
}
</script>

<div
Expand Down