Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

The PinchZoomModifier3D provides pinch zooming behavior on a 3D SciChart3DSurface within SciChart - High Performance JavaScript 3D Charts

description

To apply the PinchZoomModifier3D to a SciChart3DSurface and add pinch zoom behavior, use the following code:

const sciChartS3Durface: SciChart3DSurface;
sciChart3DSurface.chartModifiers.add(new PinchZoomModifier3D());
remarks

The speed of zoom can be modified via the {@link PinchZoomModifier3D.mouseWheelSensitivity} property.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected activePointerEvents

activePointerEvents: Map<number, ModifierMouseArgs> = new Map()

Stores info about active pointerdown events

Protected executeOnProperty

executeOnProperty: EExecuteOn = EExecuteOn.MouseLeftButton

growFactor

growFactor: number = 0.5

Defines the sensitivity of zooming

Readonly id

id: string

A unique Id for the IChartModifierBase

invalidateParentCallback

invalidateParentCallback: () => void

A callback to invalidate the parent SciChartSurfaceBase

Type declaration

    • (): void
    • Returns void

Protected isAttachedProperty

isAttachedProperty: boolean

Protected isEnabledProperty

isEnabledProperty: boolean = true

modifierGroup

modifierGroup: string | undefined

Specifies a string ID to group modifiers.

remarks

When one receives a mouse event, all modifiers in the same group receive the event.

Protected mousePoint

mousePoint: Point | undefined

Protected parentSurfaceProperty

parentSurfaceProperty: SciChart3DSurface

Protected previousHorizontalTouchPointsDistance

previousHorizontalTouchPointsDistance: number

touch points X coordinates difference

Protected previousPoint

previousPoint: Point | undefined

Protected previousVerticalTouchPointsDistance

previousVerticalTouchPointsDistance: number

touch points Y coordinates difference

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

Readonly type

Protected typeMap

typeMap: Map<string, string> = new Map<string, string>()

Accessors

canReceiveMouseEvents

  • get canReceiveMouseEvents(): boolean

executeOn

  • The operation that modifier should respond to

    inheritdoc

    Returns EExecuteOn

  • The operation that modifier should respond to

    inheritdoc

    Parameters

    Returns void

isAttached

  • get isAttached(): boolean

isEnabled

  • get isEnabled(): boolean
  • set isEnabled(isEnabled: boolean): void
  • When true, the modifier is enabled

    inheritdoc

    Returns boolean

  • When true, the modifier is enabled

    inheritdoc

    Parameters

    • isEnabled: boolean

    Returns void

modifierType

parentSurface

receiveHandledEvents

  • get receiveHandledEvents(): boolean
  • set receiveHandledEvents(receiveHandledEvents: boolean): void
  • When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.

    inheritdoc

    Returns boolean

  • When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.

    inheritdoc

    Parameters

    • receiveHandledEvents: boolean

    Returns void

Methods

applyTheme

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

Protected getIsActionAllowed

modifierDoubleClick

modifierDrop

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

modifierPointerCancel

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

  • onAttach(): void

onAttachSeries

onAttachSubSurface

onDetach

  • onDetach(): void

onDetachSeries

onDetachSubSurface

onParentSurfaceRendered

  • onParentSurfaceRendered(): void

Protected performModifierAction

  • Parameters

    Returns void

Protected performZoom

  • performZoom(mousePoint: Point, horizontalDistance: number, verticalDistance: number): void
  • Performs the zoom operation around the mouse point

    Parameters

    • mousePoint: Point

      The X,Y location of the mouse at the time of the zoom

    • horizontalDistance: number

      horizontal distance between points

    • verticalDistance: number

      vertical distance between points

    Returns void

Protected removeFromActiveTouchEvents

  • Handles pointer event becoming inactive

    Parameters

    Returns void

setParentSurface

toJSON

  • toJSON(): { options: {}; type: string }
  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Returns { options: {}; type: string }

    • options: {}
    • type: string

Protected updatePointerInfo

Generated using TypeDoc