Oracle Maps HTML5 Javascript API Reference

 
Class: Point

OM.geometry. Point

new Point(x, y, srid, orientationX, orientationY)

This class defines a n-d point with an optional orientation (heading).
constructs a 2-d point.

Parameters:
Name Type Description
x Number

Specifies the X coordinate of the point geometry.
y Number

Specifies the Y coordinate of the point geometry.
srid int

An integer that specifies the spatial reference identifier (coordinate system).
such as 8307 for the standard longitude/latitude (WGS 84) coordinate system. If none
is specified then 8307 is assumed.
orientationX Number

Optional Specifies the X coordinate of the end point of the orientation vector.
orientationY Number

Optional Specifies the X coordinate of the end point of the orientation vector.
Returns:

An instance of OM.geometry.Point.

Type
OM.geometry.Point

Extends

Methods

addDimension(dimValue [, orientValue])

Adds a new dimension to point.
Coordinates array will be extended with new value, and if oriented point a
new orientation value will also be added.

Parameters:
Name Type Argument Description
dimValue float

Dimension value
orientValue float <optional>

Orientation value (optional - applies to oriented point)
if not defined and is an oriented point, then value 0 is added.

densify()

Densify a simple geodetic or projected linestring or polygon.

MapViewer renders geodetic shapes as if they are in a two-dimentional cartesian coordinate
system, in which longitude is the X axis and latitude is the Y axis. Oracle Spatial treats
such shapes differently and always takes the spherical shape of the Earth into consideration.
A straight line with two end points is straight when being rendered by MapViewer, while it
is an arc on the Earth surface when being processed by Spatial. As the result, the result
of a spatial query with a geodetic geometry as the filter might not match the geometry shape
rendered by MapViewer. The discrepency becomes prominent when the geodetic geometry spans
across a large area. Similar discrepency can be seen when the filtering geometry of the
spatial query is in a projected system and the data been queried is geodetic.

This method can be used to address this problem. It densifies a simple linestring
or polygon by linearly interpolating additional points into line segments that expand more
than 1 longitude degree. The densified geometry will result in minimal discrepency when being
rendered on the map and used in spatial queries.

You only need to call this method explicitly to get the densified geometry when the filter
geometry is used in a dynamic JDBC theme based vector layer. There is no need to call this method
for geometry query paremeters used with a predefined theme based vecotor layer.

Inherited From:
Returns:

The densified geoemtry.

Type
OM.geometry.Geometry

getArea()

Returns the signed area of this geometry. The result is in the
square unit of the geometry's coordinates.

Note that if the geometry is clockwise then the result is a positive area,
if it is counter clockwise then a negative result is returned.

Inherited From:
Overrides:

getDimensionValue(dimension)

Returns the dimension value.

Parameters:
Name Type Description
dimension int

Index (starts at 0). Index 0 means X value, 1 means Y value,
and the following the other dimensions.
Returns:

the dimension index value or undefined if index is out of dimension range

Type
float

getLength()

Returns the total length of this geometry's segments. The result is in
the same unit as the geometry's coordinates.

Inherited From:
Overrides:

getMBR()

Get the minimum bounding rectangle (MBR) of the geometry object.

Inherited From:
Returns:

The MBR of the geometry as a Rectangle object.

Type
OM.geometry.Rectangle

getOrdinates()

Get the coordinates of the geometry object.

Inherited From:
Returns:

the coordinates.

Type
Array

getOrientationValue((int))

Returns the orientation value for dimension.

Parameters:
Name Type Description
(int)

dimension Index (starts at 0). Index 0 means X value, 1 means Y value,
and the following the other dimensions.
Returns:

(float) the dimension index value or undefined if index is out of dimension range

getOrientationX()

Get the x value of the orientation

Returns:

the x value of the orientation or undefined

Type
float

getOrientationY()

Get the y value of the orientation

getSRID()

Get the SRID of the geometry object.

Inherited From:
Returns:

SRID.

Type
int

getType()

Get the type of the geometry object.
The type string is one of the constants defined in OM.GeomTypes. e.g. "Point", "LineString", or "Polygon".

Inherited From:
Returns:

geometry type.

Type
String

getX()

Get the x ordinate of point

Returns:

the x ordinate

Type
float

getY()

Get the y ordinate of point

Returns:

the y ordinate

Type
float

isOriented()

Is the point in an oriented point.

Returns:

true if the point is an oriented point.

Type
Boolean

removeDimension((int))

Removes a dimension from point.

Parameters:
Name Type Description
(int)

dimension index. Must be greater than 1 (X and Y dimensions cannot be removed).

setDimensionValue(dimension, dimension)

Sets the dimension value.

Parameters:
Name Type Description
dimension int

Index (starts at 0). Index 0 means X value, 1 means Y value,
and the following the other dimensions.
dimension float

value

setOrientationValue(dimension, dimension)

Returns the orientation value for dimension.

Parameters:
Name Type Description
dimension int

Index (starts at 0). Index 0 means X value, 1 means Y value,
and the following the other dimensions.
dimension float

value

setPoint(x, y)

Set point

Parameters:
Name Type Description
x Number

Specifies the X coordinate of the point geometry.
y Number

Specifies the Y coordinate of the point geometry.
Returns:
Type
void

toGML()

Returns the GML string of this geometry.

toString()

This method is used to convert geometry object to a geoJSON compliant string.

Inherited From:

toWKT()

Returns the WKT string of this geometry.

transform(toSrid, callBack, mcsURL, dataSource, optObj)

Transform a geometry from one coordinate system to another.
If the original SRID and destination SRID are one of following
values: 8307, 4326, 54004, 53004, 3785, and 3857, then the transformation will be
done at the client side.
Otherwise the map client sends a request to the map tile server, which invokes Oracle
Spatial utilities to perform coordinate system transformation and returns the
result to the client.

Parameters:
Name Type Description
toSrid int

The toSrid specifies the SRID of the destination coordinate system.
callBack function

The call back function that is executed after the
coordinate system transformation is finished.
mcsURL string

An optional parameter that specifies the URL of the map tile
server to be used to perform the coordinate system transformation.
If this parameter is omitted, the map tile server associated
with the first map tile layer is used.
dataSource String

An optional parameter. It's the name of the MapViewer
data source inside which the server side length calculation is to be performed.
If omitted, the data source associated with the first map tile layer added is used.
optObj Object

An optional parameter, for example, {bdutil: bdutil}.
Inherited From:
Returns:

The resulting Geometry object when transformation in client. Null when
transformation in server side.

Type
OM.geometry.Geometry