ZoomOptions

Namespace: PP;

Inheritance Hierarchy

          PP.Object

          PP.ZoomOptions

Description

The ZoomOptions class is used to set up visual component zoom options.

Comments

To get an object of this class, use the Chart.getZoom method.

To set up visual component zoom options:

  1. Set zoom value using the ZoomOptions.setZoom method or the Zoom property in the ZoomOptions constructor.

  2. Select one of the methods of applying the specified zoom by means of CSS using the ZoomOptions.setIsOnlyPosition method or the IsOnlyPosition property in the ZoomOptions constructor:

NOTE. The zoom field is not supported in Mozilla Firefox.

The zoom value specified in the zoom or transform field should match with the value of the ZoomOptions.setZoom method or the Zoom property.

  1. Specify the field that is used as a method for applying the specified zoom using the ZoomOptions.setIsCssZoom method or the IsCssZoom property in the ZoomOptions constructor. The method or property value should match with the value of the ZoomOptions.setIsOnlyPosition method or the IsOnlyPosition property.

After executing the operations the specified zoom options are applied to a visual component.

NOTE. Zoom options setup is available only for charts. When zooming a chart, coordinates of cursor, tooltips, axis selections and other elements are offset according to the specified zoom value.

Constructor

  Constructor name Brief description
sub_image.gif ZoomOptions The ZoomOptions constructor creates an instance of the ZoomOptions class.

Methods

  Method name Brief description

getIsCssZoom

The getIsCssZoom method returns whether a visual component is zoomed using the zoom or transform field specified in CSS.
getIsOnlyPosition The getIsOnlyPosition method returns the method for applying the specified zoom by means of CSS.
getNodeOffset The getNodeOffset method returns coordinates of a visual component located in the browser visual area, taking into account zoom in pixels.
getPointOffset The getPointOffset method returns coordinates of an element located relative to a visual component taking into account zoom in pixels.
getZoom The getZoom method returns zoom value.
setIsCssZoom The setIsCssZoom method determines whether a visual component is zoomed using the zoom or transform field specified in CSS.
setIsOnlyPosition The setIsOnlyPosition method determines a method for applying the specified zoom value by means of CSS.
setZoom The setZoom method determines a zoom value.

Methods inherited from the PP.Object class

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

PP