Appearance
meos.js / STBox
Class: STBox
Defined in: core/objects/objects.generated.ts:12141
Space x time box (bbox of TSpatial).
Extends
Box
Constructors
Constructor
ts
new STBox(ptr): STBox;Defined in: core/objects/objects.generated.ts:74
Holds the pointer, as MEOSObject of MEOS.NET does.
Parameters
ptr
number
Returns
STBox
Inherited from
ts
Box.constructorProperties
ptr
ts
readonly ptr: number;Defined in: core/objects/objects.generated.ts:74
Inherited from
ts
Box.ptrMethods
[dispose]()
ts
dispose: void;Defined in: core/objects/objects.generated.ts:81
Returns
void
Inherited from
ts
Box.[dispose]above()
ts
above(box2): boolean;Defined in: core/objects/objects.generated.ts:12444
MEOS: above_stbox_stbox, above_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
adjacent()
ts
adjacent(box2): boolean;Defined in: core/objects/objects.generated.ts:12451
MEOS: adjacent_stbox_stbox, adjacent_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
after()
ts
after(box2): boolean;Defined in: core/objects/objects.generated.ts:12458
MEOS: after_stbox_stbox, after_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
alwaysOverlaps()
ts
alwaysOverlaps(temp): number;Defined in: core/objects/objects.generated.ts:12465
MEOS: always_overlaps_stbox_tgeo, always_overlaps_stbox_tcbuffer, always_overlaps_stbox_tcellindex, always_overlaps_stbox_tnpoint, always_overlaps_stbox_tpose, always_overlaps_stbox_tposechain, always_overlaps_stbox_trgeometry, chosen by the arguments' types
Parameters
temp
TNPoint | TCBuffer | TGeo | TRGeometry | TPose | TPoseChain | TQuadbin
Returns
number
area()
ts
area(spheroid?): number;Defined in: core/objects/objects.generated.ts:12477
MEOS: stbox_area
Parameters
spheroid?
boolean = true
Returns
number
asEWKB()
ts
asEWKB(variant?): Uint8Array;Defined in: core/objects/objects.generated.ts:12482
MEOS: stbox_as_ewkb
Parameters
variant?
number = 0
Returns
Uint8Array
asEWKT()
ts
asEWKT(maxdd?): string;Defined in: core/objects/objects.generated.ts:12487
MEOS: stbox_out
Parameters
maxdd?
number = 15
Returns
string
asHexEWKB()
ts
asHexEWKB(variant?): string;Defined in: core/objects/objects.generated.ts:12492
MEOS: stbox_as_hexewkb
Parameters
variant?
number = 0
Returns
string
asHexWKB()
ts
asHexWKB(variant?): string;Defined in: core/objects/objects.generated.ts:12497
MEOS: stbox_as_hexwkb
Parameters
variant?
number = 0
Returns
string
asText()
ts
asText(maxdd?): string;Defined in: core/objects/objects.generated.ts:12502
MEOS: stbox_as_text
Parameters
maxdd?
number = 15
Returns
string
asWKB()
ts
asWKB(variant?): Uint8Array;Defined in: core/objects/objects.generated.ts:12507
MEOS: stbox_as_wkb
Parameters
variant?
number = 0
Returns
Uint8Array
back()
ts
back(box2): boolean;Defined in: core/objects/objects.generated.ts:12512
MEOS: back_stbox_stbox, back_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
before()
ts
before(box2): boolean;Defined in: core/objects/objects.generated.ts:12519
MEOS: before_stbox_stbox, before_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
below()
ts
below(box2): boolean;Defined in: core/objects/objects.generated.ts:12526
MEOS: below_stbox_stbox, below_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
cmp()
ts
cmp(box2): number;Defined in: core/objects/objects.generated.ts:12533
MEOS: stbox_cmp
Parameters
box2
STBox
Returns
number
contained()
ts
contained(box2): boolean;Defined in: core/objects/objects.generated.ts:12538
MEOS: contained_stbox_stbox, contained_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
contains()
ts
contains(box2): boolean;Defined in: core/objects/objects.generated.ts:12545
MEOS: contains_stbox_stbox, contains_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
copy()
ts
copy(): STBox;Defined in: core/objects/objects.generated.ts:12552
MEOS: stbox_copy
Returns
STBox
eq()
ts
eq(box2): boolean;Defined in: core/objects/objects.generated.ts:12557
MEOS: stbox_eq
Parameters
box2
STBox
Returns
boolean
everOverlaps()
ts
everOverlaps(temp): number;Defined in: core/objects/objects.generated.ts:12562
MEOS: ever_overlaps_stbox_tgeo, ever_overlaps_stbox_tcbuffer, ever_overlaps_stbox_tcellindex, ever_overlaps_stbox_tnpoint, ever_overlaps_stbox_tpose, ever_overlaps_stbox_tposechain, ever_overlaps_stbox_trgeometry, chosen by the arguments' types
Parameters
temp
TNPoint | TCBuffer | TGeo | TRGeometry | TPose | TPoseChain | TQuadbin
Returns
number
expandSpace()
ts
expandSpace(d): STBox | null;Defined in: core/objects/objects.generated.ts:12574
MEOS: stbox_expand_space
Parameters
d
number
Returns
STBox | null
expandTime()
ts
expandTime(interv): STBox | null;Defined in: core/objects/objects.generated.ts:12579
MEOS: stbox_expand_time
Parameters
interv
Interval
Returns
STBox | null
free()
ts
free(): void;Defined in: core/objects/objects.generated.ts:77
Releases the MEOS value; the object must not be used afterwards.
Returns
void
Inherited from
ts
Box.freefront()
ts
front(box2): boolean;Defined in: core/objects/objects.generated.ts:12589
MEOS: front_stbox_stbox, front_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
ge()
ts
ge(box2): boolean;Defined in: core/objects/objects.generated.ts:12596
MEOS: stbox_ge
Parameters
box2
STBox
Returns
boolean
getSpace()
ts
getSpace(): this;Defined in: core/objects/objects.generated.ts:12601
MEOS: stbox_get_space
Returns
this
gt()
ts
gt(box2): boolean;Defined in: core/objects/objects.generated.ts:12606
MEOS: stbox_gt
Parameters
box2
STBox
Returns
boolean
hash()
ts
hash(): number;Defined in: core/objects/objects.generated.ts:12611
MEOS: stbox_hash
Returns
number
hashExtended()
ts
hashExtended(seed): bigint;Defined in: core/objects/objects.generated.ts:12616
MEOS: stbox_hash_extended
Parameters
seed
bigint
Returns
bigint
hast()
ts
hast(): boolean;Defined in: core/objects/objects.generated.ts:12621
MEOS: stbox_hast
Returns
boolean
hasx()
ts
hasx(): boolean;Defined in: core/objects/objects.generated.ts:12626
MEOS: stbox_hasx
Returns
boolean
hasz()
ts
hasz(): boolean;Defined in: core/objects/objects.generated.ts:12631
MEOS: stbox_hasz
Returns
boolean
intersection()
ts
intersection(box2): STBox | null;Defined in: core/objects/objects.generated.ts:12636
MEOS: intersection_stbox_stbox
Parameters
box2
STBox
Returns
STBox | null
isgeodetic()
ts
isgeodetic(): boolean;Defined in: core/objects/objects.generated.ts:12641
MEOS: stbox_isgeodetic
Returns
boolean
le()
ts
le(box2): boolean;Defined in: core/objects/objects.generated.ts:12646
MEOS: stbox_le
Parameters
box2
STBox
Returns
boolean
left()
ts
left(box2): boolean;Defined in: core/objects/objects.generated.ts:12651
MEOS: left_stbox_stbox, left_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
lt()
ts
lt(box2): boolean;Defined in: core/objects/objects.generated.ts:12658
MEOS: stbox_lt
Parameters
box2
STBox
Returns
boolean
nad()
ts
nad(gs, spheroid?): number;Defined in: core/objects/objects.generated.ts:12663
MEOS: nad_stbox_geo, nad_stbox_stbox, nad_stbox_trgeometry, chosen by the arguments' types
Parameters
gs
Geo | STBox | TRGeometry
spheroid?
boolean
Returns
number
ne()
ts
ne(box2): boolean;Defined in: core/objects/objects.generated.ts:12671
MEOS: stbox_ne
Parameters
box2
STBox
Returns
boolean
overabove()
ts
overabove(box2): boolean;Defined in: core/objects/objects.generated.ts:12676
MEOS: overabove_stbox_stbox, overabove_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overafter()
ts
overafter(box2): boolean;Defined in: core/objects/objects.generated.ts:12683
MEOS: overafter_stbox_stbox, overafter_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overback()
ts
overback(box2): boolean;Defined in: core/objects/objects.generated.ts:12690
MEOS: overback_stbox_stbox, overback_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overbefore()
ts
overbefore(box2): boolean;Defined in: core/objects/objects.generated.ts:12697
MEOS: overbefore_stbox_stbox, overbefore_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overbelow()
ts
overbelow(box2): boolean;Defined in: core/objects/objects.generated.ts:12704
MEOS: overbelow_stbox_stbox, overbelow_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overfront()
ts
overfront(box2): boolean;Defined in: core/objects/objects.generated.ts:12711
MEOS: overfront_stbox_stbox, overfront_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overlaps()
ts
overlaps(box2): boolean;Defined in: core/objects/objects.generated.ts:12718
MEOS: overlaps_stbox_stbox, overlaps_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overleft()
ts
overleft(box2): boolean;Defined in: core/objects/objects.generated.ts:12725
MEOS: overleft_stbox_stbox, overleft_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
overright()
ts
overright(box2): boolean;Defined in: core/objects/objects.generated.ts:12732
MEOS: overright_stbox_stbox, overright_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
perimeter()
ts
perimeter(spheroid?): number;Defined in: core/objects/objects.generated.ts:12739
MEOS: stbox_perimeter
Parameters
spheroid?
boolean = true
Returns
number
quadSplit()
ts
quadSplit(): STBox[];Defined in: core/objects/objects.generated.ts:12744
MEOS: stbox_quad_split
Returns
STBox[]
right()
ts
right(box2): boolean;Defined in: core/objects/objects.generated.ts:12764
MEOS: right_stbox_stbox, right_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
round()
ts
round(maxdd?): this;Defined in: core/objects/objects.generated.ts:12771
MEOS: stbox_round
Parameters
maxdd?
number = 0
Returns
this
same()
ts
same(box2): boolean;Defined in: core/objects/objects.generated.ts:12776
MEOS: same_stbox_stbox, same_stbox_tspatial, chosen by the arguments' types
Parameters
box2
TSpatial | STBox
Returns
boolean
scaleTime()
ts
scaleTime(duration): this;Defined in: core/objects/objects.generated.ts:12783
MEOS: stbox_scale_time
Parameters
duration
Interval
Returns
this
setSRID()
ts
setSRID(srid): this;Defined in: core/objects/objects.generated.ts:12793
MEOS: stbox_set_srid
Parameters
srid
number
Returns
this
shiftScaleTime()
ts
shiftScaleTime(shift, duration): this;Defined in: core/objects/objects.generated.ts:12798
MEOS: stbox_shift_scale_time
Parameters
shift
Interval
duration
Interval
Returns
this
shiftTime()
ts
shiftTime(shift): this;Defined in: core/objects/objects.generated.ts:12810
MEOS: stbox_shift_time
Parameters
shift
Interval
Returns
this
sortkey()
ts
sortkey(): Uint8Array;Defined in: core/objects/objects.generated.ts:12820
MEOS: stbox_sortkey
Returns
Uint8Array
spaceTiles()
ts
spaceTiles(
xsize,
ysize,
zsize,
sorigin,
border_inc): STBox[];Defined in: core/objects/objects.generated.ts:12825
MEOS: stbox_space_tiles
Parameters
xsize
number
ysize
number
zsize
number
sorigin
Geo
border_inc
boolean
Returns
STBox[]
spaceTimeTiles()
ts
spaceTimeTiles(
xsize,
ysize,
zsize,
duration,
sorigin,
torigin,
border_inc): STBox[];Defined in: core/objects/objects.generated.ts:12845
MEOS: stbox_space_time_tiles
Parameters
xsize
number
ysize
number
zsize
number
duration
Interval
sorigin
Geo
torigin
bigint
border_inc
boolean
Returns
STBox[]
spatialDistance()
ts
spatialDistance(box2): number;Defined in: core/objects/objects.generated.ts:12867
MEOS: stbox_spatial_distance
Parameters
box2
STBox
Returns
number
SRID()
ts
SRID(): number;Defined in: core/objects/objects.generated.ts:12872
MEOS: stbox_srid
Returns
number
timeTiles()
ts
timeTiles(
duration,
torigin,
border_inc?): STBox[];Defined in: core/objects/objects.generated.ts:12877
MEOS: stbox_time_tiles
Parameters
duration
Interval
torigin
bigint
border_inc?
boolean = true
Returns
STBox[]
tmax()
ts
tmax(): bigint;Defined in: core/objects/objects.generated.ts:12899
MEOS: stbox_tmax
Returns
bigint
tmaxInc()
ts
tmaxInc(): boolean;Defined in: core/objects/objects.generated.ts:12904
MEOS: stbox_tmax_inc
Returns
boolean
tmin()
ts
tmin(): bigint;Defined in: core/objects/objects.generated.ts:12909
MEOS: stbox_tmin
Returns
bigint
tminInc()
ts
tminInc(): boolean;Defined in: core/objects/objects.generated.ts:12914
MEOS: stbox_tmin_inc
Returns
boolean
toBox3d()
ts
toBox3d(): BOX3D;Defined in: core/objects/objects.generated.ts:12919
MEOS: stbox_to_box3d
Returns
BOX3D
toGbox()
ts
toGbox(): GBOX;Defined in: core/objects/objects.generated.ts:12924
MEOS: stbox_to_gbox
Returns
GBOX
toGeo()
ts
toGeo(): Geo;Defined in: core/objects/objects.generated.ts:12929
MEOS: stbox_to_geo
Returns
Geo
toGeog()
ts
toGeog(): Geo;Defined in: core/objects/objects.generated.ts:12934
MEOS: stbox_to_geog
Returns
Geo
toGeom()
ts
toGeom(): Geo;Defined in: core/objects/objects.generated.ts:12939
MEOS: stbox_to_geom
Returns
Geo
toString()
ts
toString(): string;Defined in: core/objects/objects.generated.ts:12144
The text MEOS writes this value as (MEOS: stbox_as_text).
Returns
string
toTstzspan()
ts
toTstzspan(): Span;Defined in: core/objects/objects.generated.ts:12944
MEOS: stbox_to_tstzspan
Returns
transform()
ts
transform(srid): STBox | null;Defined in: core/objects/objects.generated.ts:12949
MEOS: stbox_transform
Parameters
srid
number
Returns
STBox | null
transformPipeline()
ts
transformPipeline(
pipelinestr,
srid?,
is_forward?): this;Defined in: core/objects/objects.generated.ts:12954
MEOS: stbox_transform_pipeline
Parameters
pipelinestr
string
srid?
number = 0
is_forward?
boolean = true
Returns
this
union()
ts
union(box2, strict): this;Defined in: core/objects/objects.generated.ts:12959
MEOS: union_stbox_stbox
Parameters
box2
STBox
strict
boolean
Returns
this
volume()
ts
volume(): number;Defined in: core/objects/objects.generated.ts:12964
MEOS: stbox_volume
Returns
number
xmax()
ts
xmax(): number;Defined in: core/objects/objects.generated.ts:12969
MEOS: stbox_xmax
Returns
number
xmin()
ts
xmin(): number;Defined in: core/objects/objects.generated.ts:12974
MEOS: stbox_xmin
Returns
number
ymax()
ts
ymax(): number;Defined in: core/objects/objects.generated.ts:12979
MEOS: stbox_ymax
Returns
number
ymin()
ts
ymin(): number;Defined in: core/objects/objects.generated.ts:12984
MEOS: stbox_ymin
Returns
number
zmax()
ts
zmax(): number;Defined in: core/objects/objects.generated.ts:12989
MEOS: stbox_zmax
Returns
number
zmin()
ts
zmin(): number;Defined in: core/objects/objects.generated.ts:12994
MEOS: stbox_zmin
Returns
number
fromBox3d()
ts
static fromBox3d(box): STBox;Defined in: core/objects/objects.generated.ts:12999
MEOS: box3d_to_stbox
Parameters
box
BOX3D
Returns
STBox
fromEWKB()
ts
static fromEWKB(wkb): STBox;Defined in: core/objects/objects.generated.ts:13009
MEOS: stbox_from_wkb
Parameters
wkb
Uint8Array
Returns
STBox
fromEWKT()
ts
static fromEWKT(str): STBox;Defined in: core/objects/objects.generated.ts:13014
MEOS: stbox_in
Parameters
str
string
Returns
STBox
fromGbox()
ts
static fromGbox(box): STBox;Defined in: core/objects/objects.generated.ts:13019
MEOS: gbox_to_stbox
Parameters
box
GBOX
Returns
STBox
fromHexEWKB()
ts
static fromHexEWKB(hexwkb): STBox;Defined in: core/objects/objects.generated.ts:13029
MEOS: stbox_from_hexwkb
Parameters
hexwkb
string
Returns
STBox
fromHexWKB()
ts
static fromHexWKB(hexwkb): STBox;Defined in: core/objects/objects.generated.ts:13034
MEOS: stbox_from_hexwkb
Parameters
hexwkb
string
Returns
STBox
fromText()
ts
static fromText(str): STBox;Defined in: core/objects/objects.generated.ts:13039
MEOS: stbox_in
Parameters
str
string
Returns
STBox
fromTimestamptz()
ts
static fromTimestamptz(t): STBox;Defined in: core/objects/objects.generated.ts:13044
MEOS: timestamptz_to_stbox
Parameters
t
bigint
Returns
STBox
fromWKB()
ts
static fromWKB(wkb): STBox;Defined in: core/objects/objects.generated.ts:13049
MEOS: stbox_from_wkb
Parameters
wkb
Uint8Array
Returns
STBox
getSpaceTile()
ts
static getSpaceTile(
point,
xsize,
ysize,
zsize,
sorigin): STBox | null;Defined in: core/objects/objects.generated.ts:13059
MEOS: stbox_get_space_tile
Parameters
point
Geo
xsize
number
ysize
number
zsize
number
sorigin
Geo
Returns
STBox | null
getSpaceTimeTile()
ts
static getSpaceTimeTile(
point,
t,
xsize,
ysize,
zsize,
duration,
sorigin,
torigin): STBox | null;Defined in: core/objects/objects.generated.ts:13064
MEOS: stbox_get_space_time_tile
Parameters
point
Geo
t
bigint
xsize
number
ysize
number
zsize
number
duration
Interval
sorigin
Geo
torigin
bigint
Returns
STBox | null
getTimeTile()
ts
static getTimeTile(
t,
duration,
torigin): STBox;Defined in: core/objects/objects.generated.ts:13074
MEOS: stbox_get_time_tile
Parameters
t
bigint
duration
Interval
torigin
bigint
Returns
STBox
make()
ts
static make(
hasx,
hasz,
geodetic,
srid,
xmin,
xmax,
ymin,
ymax,
zmin,
zmax,
s): STBox;Defined in: core/objects/objects.generated.ts:13084
MEOS: stbox_make
Parameters
hasx
boolean
hasz
boolean
geodetic
boolean
srid
number
xmin
number
xmax
number
ymin
number
ymax
number
zmin
number
zmax
number
s
Returns
STBox