IPositioningContext

Interface for the positioning context, an object that allows to position an object inside itself that is defined by global pixel coordinates.

Constructor | Methods

Constructor

IPositioningContext()

Methods

NameReturnsDescription
fromClientPixels(clientPixelPoint)

Number[]

Converts client pixel coordinates to global coordinates.

getZoom()

Number

Returns the current zoom level at which the positioning context works.

toClientPixels(globalPixelPoint)

Number[]

Converts global pixel coordinates to client coordinates.

Methods details

fromClientPixels

{Number[]} fromClientPixels(clientPixelPoint)

Converts client pixel coordinates to global coordinates.

Returns global pixel coordinates.

Parameters:

ParameterDefault valueDescription
clientPixelPoint *

Type: Number[]

Client pixel coordinates.

* Mandatory parameter/option.

getZoom

{Number} getZoom()

Returns the current zoom level at which the positioning context works.

toClientPixels

{Number[]} toClientPixels(globalPixelPoint)

Converts global pixel coordinates to client coordinates.

Returns client pixel coordinates.

Parameters:

ParameterDefault valueDescription
globalPixelPoint *

Type: Number[]

Global pixel coordinates.

* Mandatory parameter/option.