Skip to main content

Interface: GtcChartsPanZoomControlPopupProps

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Popups/ChartsPanZoomControlPopup/GtcChartsPanZoomControlPopup.tsx:21

Component props for GtcChartsPanZoomControlPopup.

Extends

Properties

children?

optional children: DisplayChildren[]

Defined in: sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from

GtcViewProps.children


controlMode

controlMode: GtcControlMode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:17

The GTC control mode to which the view belongs.

Inherited from

GtcViewProps.controlMode


displayPaneIndex?

optional displayPaneIndex: ControllableDisplayPaneIndex

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:26

The index of the display pane associated with the view, or undefined if the view is not associated with any display pane.

Inherited from

GtcViewProps.displayPaneIndex


gtcService

gtcService: GtcService

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:14

The GtcService instance.

Inherited from

GtcViewProps.gtcService


isInOverlayStack?

optional isInOverlayStack: boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:20

Whether the view belongs to its GTC control mode's overlay view stack.

Inherited from

GtcViewProps.isInOverlayStack


ref?

optional ref: NodeReference<any>

Defined in: sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

GtcViewProps.ref


touchDragDistanceMap()?

optional touchDragDistanceMap: (distance, dt) => number

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Popups/ChartsPanZoomControlPopup/GtcChartsPanZoomControlPopup.tsx:28

A function which maps mouse drag distances on the touchpad to chart pan distances.

Parameters

ParameterTypeDescription
distancenumberA touchpad mouse drag distance, in pixels.
dtnumberThe time, in milliseconds, over which the mouse drag distance was performed.

Returns

number

The distance the chart should be panned given the specified mouse drag distance and elapsed time.