Interface: PanAreaProps
Hierarchy
↳
PanAreaProps
Properties
allowUserPan
• Optional allowUserPan: boolean
Enable or disable the user's ability to change the pan offset with a click and drag.
Default
true
Defined in
packages/ida-framework/src/layout/PanArea.tsx:43
animateOnPan
• Optional animateOnPan: boolean
Whether to use a CSS transition to update the pan offset.
Default
false
Defined in
packages/ida-framework/src/layout/PanArea.tsx:58
ariaLabel
• Optional ariaLabel: string
Deprecated
- Use kebab-case aria-label instead Label to be used for accessibility purposes.
Inherited from
SharedComponentProps.ariaLabel
Defined in
packages/ida-framework/src/types.ts:46
children
• children: ReactNode | ReactNode[]
Defined in
packages/ida-framework/src/layout/PanArea.tsx:26
className
• Optional className: string
Inherited from
SharedComponentProps.className
Defined in
packages/ida-framework/src/types.ts:48
onAnimationEnd
• Optional onAnimationEnd: () => void
Type declaration
▸ (): void
Callback fired when the CSS transition ends.
Returns
void
Defined in
packages/ida-framework/src/layout/PanArea.tsx:62
panOffset
• panOffset: Object
The current offset from the top-left of the pan container.
Type declaration
| Name | Type |
|---|---|
x | number |
y | number |
Defined in
packages/ida-framework/src/layout/PanArea.tsx:30
panOffsetChange
• panOffsetChange: (value: { x: number ; y: number }) => void
Type declaration
▸ (value): void
A callback containing the new offset x and y. Fired whenever the user finishes an interaction, such as right-click and drag.
Parameters
| Name | Type |
|---|---|
value | Object |
value.x | number |
value.y | number |
Returns
void
Defined in
packages/ida-framework/src/layout/PanArea.tsx:34
panTransitionDuration
• Optional panTransitionDuration: number
Duration in milliseconds of the transition from the old pan offset to the new one.
Default
500
Defined in
packages/ida-framework/src/layout/PanArea.tsx:48
panTransitionTiming
• Optional panTransitionTiming: string
The transition-timing-function for the pan transition.
Default
'ease-in-out'
Defined in
packages/ida-framework/src/layout/PanArea.tsx:53
registerPanContainer
• Optional registerPanContainer: (element: HTMLDivElement) => void
Type declaration
▸ (element): void
Fired with the pan container's ref once on mount.
Parameters
| Name | Type |
|---|---|
element | HTMLDivElement |
Returns
void
Defined in
packages/ida-framework/src/layout/PanArea.tsx:38
role
• Optional role: AriaRole
Inherited from
Defined in
packages/ida-framework/src/types.ts:49
style
• Optional style: CSSProperties