Options
All
  • Public
  • Public/Protected
  • All
Menu

The ZoomExtentsModifier provides double-tap or double-click to zoom-to-fit (Zoom Extents) behavior on a 2D SciChartSurface within SciChart - High Performance JavaScript Charts

remarks

To apply the ZoomExtentsModifier to a SciChartSurface and add drag to zoom behavior, use the following code:

const sciChartSurface: SciChartSurface;
sciChartSurface.chartModifiers.add(new ZoomExtentsModifier());

Animation of the zoom extents be controlled via the ZoomExtentsModifier.isAnimated, ZoomExtentsModifier.animationDuration and ZoomExtentsModifier.easingFunction properties.

Hierarchy

Implements

Index

Constructors

constructor

Properties

animationDuration

animationDuration: number = 400

Defines the duration of animations when zooming in milliseconds

Protected changedPropertiesList

changedPropertiesList: string[] = []

easingFunction

easingFunction: TEasing = easing.outExpo

Defines the easing function for animation. See TEasing for a range of functions

invalidateParentCallback

invalidateParentCallback: () => void

A callback to invalidate the parent SciChartSurfaceBase

Type declaration

    • (): void
    • Returns void

isAnimated

isAnimated: boolean = true

When true, the Zoom operations are animated. See also animationDuration and easingFunction

Protected isAttachedProperty

isAttachedProperty: boolean

Protected isEnabledProperty

isEnabledProperty: boolean = true

modifierGroup

modifierGroup: string

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

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

xyDirection

xyDirection: EXyDirection = EXyDirection.XyDirection

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

modifierDoubleClick

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

  • onAttach(): void

onAttachSeries

onDetach

  • onDetach(): void

onDetachSeries

onParentSurfaceRendered

  • onParentSurfaceRendered(): void

setParentSurface

Protected testPropertyChanged

  • testPropertyChanged(propertyName: string): boolean

Generated using TypeDoc