Function List¶
Generated list of available functions at the time of writing:
DefaultFunctionFactory
¶
Contains 203 functions.
Area(geometry)
: returns area
¶
geometry
(Geometry
) requiredarea
(Double
)
Categorize(LookupValue, Value, Threshold 1, Value 1, Threshold 2, Value 2, succeeding or preceding)
: returns return
¶
LookupValue
Value
Threshold 1
Value 1
Threshold 2
Value 2
succeeding or preceding
return
Collection_Average(expression)
: returns average
¶
expression
(Number
) requiredaverage
(Number
)
Collection_Bounds(geometry)
: returns bounds
¶
geometry
(Geometry
) requiredbounds
Collection_Count(features)
: returns count
¶
features
count
(Number
)
Collection_Max(expression)
: returns max
¶
expression
(Comparable
) requiredmax
(Comparable
)
Collection_Median(expression)
: returns median
¶
expression
(Comparable
) requiredmedian
(Comparable
)
Collection_Min(expression)
: returns min
¶
expression
(Comparable
) requiredmin
(Comparable
)
Collection_Nearest(value)
: returns expression
¶
value
(Comparable
) requiredexpression
(Expression
)
Collection_Sum(expression)
: returns sum
¶
expression
(Number
) requiredsum
(Number
)
Collection_Unique(expression)
: returns unique
¶
expression
unique
Concatenate(text)
: returns result
¶
text
(String
) requiredresult
(String
)
EqualArea(value, classes, areaFunction, percentages)
: returns EqualArea
¶
value
(Double
) requiredclasses
(Integer
) requiredareaFunction
(Double
) optional if no parameter follows, otherwise requiredpercentages
(Boolean
) optionalEqualArea
(RangedClassifier
)
EqualInterval(value, classes, percentages)
: returns EqualInterval
¶
value
(Double
) requiredclasses
(Integer
) requiredpercentages
(Boolean
) optionalEqualInterval
(RangedClassifier
)
IEEEremainder(dividend, divisor)
: returns remainder
¶
dividend
(Number
) requireddivisor
(Number
) requiredremainder
(Double
)
Interpolate(data value pairs, mode, method)
: returns lookup
¶
data value pairs
mode
(String
) requiredmethod
(String
) optionallookup
Jenks(value, classes, percentages)
: returns Jenks
¶
value
(Double
) requiredclasses
(Integer
) requiredpercentages
(Boolean
) optionalJenks
(RangedClassifier
)
PropertyExists(propertyName)
: returns exists
¶
propertyName
exists
(Boolean
)
Quantile(value, classes, percentages)
: returns Quantile
¶
value
(Double
) requiredclasses
(Integer
) requiredpercentages
(Boolean
) optionalQuantile
(RangedClassifier
)
Recode(LookupValue, Data 1, Value 1, Data 2, Value 2)
: returns return
¶
LookupValue
Data 1
Value 1
Data 2
Value 2
return
StandardDeviation(value, classes, percentages)
: returns StandardDeviation
¶
value
(Double
) requiredclasses
(Integer
) requiredpercentages
(Boolean
) optionalStandardDeviation
(RangedClassifier
)
UniqueInterval(value, classes, percentages)
: returns UniqueInterval
¶
value
(Double
) requiredclasses
(Integer
) requiredpercentages
(Boolean
) optionalUniqueInterval
(RangedClassifier
)
abs(int)
: returns abs
¶
int
(Integer
) requiredabs
(Integer
)
abs_2(number)
: returns long
¶
number
(Long
) requiredlong
(Long
)
abs_3(number)
: returns float
¶
number
(Float
) requiredfloat
(Float
)
abs_4(number)
: returns double
¶
number
(Double
) requireddouble
(Double
)
acos(value)
: returns arc cosine
¶
value
(Double
) requiredarc cosine
(Double
)
area2(geometry)
: returns area
¶
geometry
(Geometry
) requiredarea
(Double
)
asin(value)
: returns arc sine
¶
value
(Double
) requiredarc sine
(Double
)
atan(value)
: returns arc tan
¶
value
(Double
) requiredarc tan
(Double
)
atan2(x, y)
: returns arc tan
¶
x
(Double
) requiredy
(Double
) requiredarc tan
(Double
)
attributeCount(count)
: returns return
¶
count
return
between(value, min, max)
: returns between
¶
value
min
max
between
(Boolean
)
boundary(geometry)
: returns boundary
¶
geometry
(Geometry
) requiredboundary
(Geometry
)
boundaryDimension(geometry)
: returns dimension
¶
geometry
(Geometry
) requireddimension
(Integer
)
boundedBy()
: returns result
¶
result
(Geometry
)
buffer(geometry, distance)
: returns buffer
¶
geometry
(Geometry
) requireddistance
(Number
) requiredbuffer
(Geometry
)
bufferWithSegments(geometry, distance, numberOfSegments)
: returns buffer
¶
geometry
(Geometry
) requireddistance
(Number
) requirednumberOfSegments
(Number
) requiredbuffer
(Geometry
)
ceil(number)
: returns ceiling
¶
number
(Number
) requiredceiling
(Double
)
centroid(geometry)
: returns centroid
¶
geometry
(Geometry
) requiredcentroid
(Point
)
classify(expression, classifer)
: returns value
¶
expression
classifer
(Classifier
) requiredvalue
contains(geometry1, geometry2)
: returns contains
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredcontains
(Boolean
)
contrast(reference, color1, color2, threshold)
: returns result
¶
reference
(Color
) requiredcolor1
(Color
) optionalcolor2
(Color
) optionalthreshold
(Double
) optionalresult
(Color
)
convert(value, class)
: returns converted
¶
value
class
(Class
) requiredconverted
convexHull(geometry)
: returns hull
¶
geometry
(Geometry
) requiredhull
(Geometry
)
cos(radians)
: returns cosine
¶
radians
(Double
) requiredcosine
(Double
)
crosses(geometry1, geometry2)
: returns crosses
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredcrosses
(Boolean
)
darken(color, amount, method)
: returns result
¶
color
(Color
) requiredamount
(Float
) requiredmethod
(Method
) optionalresult
(Color
)
dateDifference(a, b)
: returns result
¶
a
(Date
) requiredb
(Date
) requiredresult
(Long
)
dateFormat(format, date)
: returns formatted
¶
format
(String
) requireddate
(Date
) requiredformatted
(String
)
dateParse(format, dateString)
: returns date
¶
format
(String
) requireddateString
(String
) requireddate
(Date
)
desaturate(color, amount, method)
: returns result
¶
color
(Color
) requiredamount
(Float
) requiredmethod
(Method
) optionalresult
(Color
)
difference(geometry1, geometry2)
: returns difference
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddifference
(Geometry
)
dimension(geometry)
: returns dimension
¶
geometry
(Geometry
) requireddimension
(Integer
)
disjoint(geometry1, geometry2)
: returns disjoint
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddisjoint
(Boolean
)
disjoint3D(geometry1, geometry2)
: returns disjoint3D
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddisjoint3D
(Double
)
distance(geometry1, geometry2)
: returns distance
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddistance
(Double
)
distance3D(geometry1, geometry2)
: returns distance3D
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddistance3D
(Double
)
double2bool(double)
: returns double2bool
¶
double
(Double
) requireddouble2bool
(Boolean
)
endAngle(linestring)
: returns endAngle
¶
linestring
(LineString
) requiredendAngle
(Double
)
endPoint(linestring)
: returns endPoint
¶
linestring
(LineString
) requiredendPoint
(Point
)
env(variable)
: returns value
¶
variable
(String
) requiredvalue
envelope(geometry)
: returns envelope
¶
geometry
(Geometry
) requiredenvelope
(Geometry
)
equalTo(a, b)
: returns equalTo
¶
a
b
equalTo
(Boolean
)
equalsExact(geometry1, geometry2)
: returns equalsExact
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredequalsExact
(Boolean
)
equalsExactTolerance(geometry1, geometry2, tolarance)
: returns equalsExactTolerance
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredtolarance
(Double
) requiredequalsExactTolerance
(Boolean
)
exp(number)
: returns exponent
¶
number
(Number
) requiredexponent
(Double
)
exteriorRing(geometry)
: returns exteriorRing
¶
geometry
(Geometry
) requiredexteriorRing
(LinearRing
)
floor(double)
: returns floor
¶
double
(Double
) requiredfloor
(Double
)
geomFromWKT(geometry)
: returns geomFromWKT
¶
geometry
(String
) requiredgeomFromWKT
(Geometry
)
geomLength(geometry)
: returns geomLength
¶
geometry
(Geometry
) requiredgeomLength
(Double
)
geometry()
: returns geometry
¶
geometry
(Boolean
)
geometryType(geometry)
: returns geometryType
¶
geometry
(Geometry
) requiredgeometryType
(String
)
getGeometryN(geometry, index)
: returns getGeometryN
¶
geometry
(Geometry
) requiredindex
(Integer
) requiredgetGeometryN
(Geometry
)
getX(geometry)
: returns getX
¶
geometry
(Geometry
) requiredgetX
(Double
)
getY(geometry)
: returns getY
¶
geometry
(Geometry
) requiredgetY
(Double
)
getz(geometry)
: returns getz
¶
geometry
(Geometry
) requiredgetz
(Double
)
grayscale(color)
: returns result
¶
color
(Color
) requiredresult
(Color
)
greaterEqualThan(x, y)
: returns greaterEqualThan
¶
x
y
greaterEqualThan
(Boolean
)
greaterThan(x, y)
: returns greaterThan
¶
x
y
greaterThan
(Boolean
)
hsl(hue, saturation, lightness)
: returns result
¶
hue
(Double
) requiredsaturation
(Double
) requiredlightness
(Double
) requiredresult
(Color
)
id()
: returns id
¶
id
(String
)
if_then_else(condition, then, else)
: returns if_then_else
¶
condition
(Boolean
) requiredthen
else
if_then_else
in(candidate, v)
: returns result
¶
candidate
v
result
(Boolean
)
in10(value, in1, in2, in3, in4, in5, in6, in7, in8, in9, in10)
: returns in10
¶
value
in1
in2
in3
in4
in5
in6
in7
in8
in9
in10
in10
(Boolean
)
in2(value, in1, in2)
: returns in2
¶
value
in1
in2
in2
(Boolean
)
in3(value, in1, in2, in3)
: returns in3
¶
value
in1
in2
in3
in3
(Boolean
)
in4(value, in1, in2, in3, in4)
: returns in4
¶
value
in1
in2
in3
in4
in4
(Boolean
)
in5(value, in1, in2, in3, in4, in5)
: returns in5
¶
value
in1
in2
in3
in4
in5
in5
(Boolean
)
in6(value, in1, in2, in3, in4, in5, in6)
: returns in6
¶
value
in1
in2
in3
in4
in5
in6
in6
(Boolean
)
in7(value, in1, in2, in3, in4, in5, in6, in7)
: returns in7
¶
value
in1
in2
in3
in4
in5
in6
in7
in7
(Boolean
)
in8(value, in1, in2, in3, in4, in5, in6, in7, in8)
: returns in8
¶
value
in1
in2
in3
in4
in5
in6
in7
in8
in8
(Boolean
)
in9(value, in1, in2, in3, in4, in5, in6, in7, in8, in9)
: returns in9
¶
value
in1
in2
in3
in4
in5
in6
in7
in8
in9
in9
(Boolean
)
int2bbool(int)
: returns int2bbool
¶
int
(Integer
) requiredint2bbool
(Boolean
)
int2ddouble(int)
: returns int2ddouble
¶
int
(Integer
) requiredint2ddouble
(Double
)
interiorPoint(geometry)
: returns interiorPoint
¶
geometry
(Geometry
) requiredinteriorPoint
(Point
)
interiorRingN(geometry, n)
: returns interiorRingN
¶
geometry
(Geometry
) requiredn
(Integer
) requiredinteriorRingN
(LinearRing
)
intersection(geometry1, geometry2)
: returns intersection
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredintersection
(Geometry
)
intersects(geometry1, geometry2)
: returns intersects
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredintersects
(Boolean
)
intersects3D(geometry1, geometry2)
: returns intersects3D
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredintersects3D
(Double
)
isClosed(geometry)
: returns isClosed
¶
geometry
(Geometry
) requiredisClosed
(Boolean
)
isCoverage()
: returns isCoverage
¶
isCoverage
(Boolean
)
isEmpty(geometry)
: returns isEmpty
¶
geometry
(Geometry
) requiredisEmpty
(Boolean
)
isLike(string, regex)
: returns isLike
¶
string
(String
) requiredregex
(String
) requiredisLike
(Boolean
)
isNull(object)
: returns isNull
¶
object
isNull
(Boolean
)
isRing(geometry)
: returns isRing
¶
geometry
(Geometry
) requiredisRing
(Boolean
)
isSimple(geometry)
: returns isSimple
¶
geometry
(Geometry
) requiredisSimple
(Boolean
)
isValid(geometry)
: returns isValid
¶
geometry
(Geometry
) requiredisValid
(Boolean
)
isWithinDistance(geometry1, geometry2, distance)
: returns isWithinDistance
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddistance
(Double
) requiredisWithinDistance
(Boolean
)
isWithinDistance3D(geometry1, geometry2, distance)
: returns isWithinDistance3D
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requireddistance
(Double
) requiredisWithinDistance3D
(Double
)
isometric(geometry, extrusion)
: returns isometric
¶
geometry
(Geometry
) requiredextrusion
(Double
) requiredisometric
(Geometry
)
jsonPointer(json, pointer)
: returns result
¶
json
(String
) requiredpointer
(String
) requiredresult
lapply(source, expression)
: returns result
¶
source
(List
) requiredexpression
result
(List
)
length(string)
: returns length
¶
string
(String
) requiredlength
(Integer
)
lessEqualThan(a, b)
: returns lessEqualThan
¶
a
(Number
) requiredb
(Number
) requiredlessEqualThan
(Boolean
)
lessThan(a, b)
: returns lessThan
¶
a
(Number
) requiredb
(Number
) requiredlessThan
(Boolean
)
lighten(color, amount, method)
: returns result
¶
color
(Color
) requiredamount
(Float
) requiredmethod
(Method
) optionalresult
(Color
)
list(item)
: returns list
¶
item
list
(List
)
listMultiply(factor, list)
: returns listMultiply
¶
factor
(Number
) requiredlist
(String
) requiredlistMultiply
(String
)
litem(source, index)
: returns result
¶
source
(List
) requiredindex
(Integer
) requiredresult
literate(index, times, expression)
: returns result
¶
index
times
(Integer
) requiredexpression
result
(List
)
log(value)
: returns logarithm
¶
value
(Number
) requiredlogarithm
(Double
)
max(double, double)
: returns maxium
¶
double
(Number
) requireddouble
(Number
) requiredmaxium
(Double
)
max_2(long, long)
: returns maximum
¶
long
(Number
) requiredlong
(Number
) requiredmaximum
(Long
)
max_3(float, float)
: returns maximum
¶
float
(Number
) requiredfloat
(Number
) requiredmaximum
(Float
)
max_4(int, int)
: returns maximum
¶
int
(Number
) requiredint
(Number
) requiredmaximum
(Integer
)
min(double, double)
: returns minium
¶
double
(Double
) requireddouble
(Double
) requiredminium
(Double
)
min_2(long, long)
: returns minium
¶
long
(Number
) requiredlong
(Number
) requiredminium
(Long
)
min_3(float, float)
: returns minium
¶
float
(Number
) requiredfloat
(Number
) requiredminium
(Float
)
min_4(int, int)
: returns minium
¶
int
(Number
) requiredint
(Number
) requiredminium
(Integer
)
mincircle(geometry)
: returns mincircle
¶
geometry
(Geometry
) requiredmincircle
(Geometry
)
minimumdiameter(geometry)
: returns minimumdiameter
¶
geometry
(Geometry
) requiredminimumdiameter
(Geometry
)
minrectangle(geometry)
: returns minrectangle
¶
geometry
(Geometry
) requiredminrectangle
(Geometry
)
mix(color1, color2, weight)
: returns result
¶
color1
(Color
) requiredcolor2
(Color
) requiredweight
(Double
) requiredresult
(Color
)
northFix(targetCRS, point, angle, sourceCRS)
: returns result
¶
targetCRS
(CoordinateRefereneSystem
) required. Rendering CRS.point
(Point
) required. Point where the north direction is computed.angle
(Double
) optional. Angle to be north-fixed. Default is 0.sourceCRS
(CoordinateRefereneSystem
) optional. CRS of the source point. If missing, automatically looked up from the geometry user data, the feature type description, or the point SRID.
modulo(dividend, divisor)
: returns modulo
¶
dividend
(Integer
) requireddivisor
(Integer
) requiredmodulo
(Integer
)
not(logicValue)
: returns not
¶
logicValue
(Boolean
) requirednot
(Boolean
)
notEqualTo(a, b)
: returns notEqualTo
¶
a
b
notEqualTo
(Boolean
)
numGeometries(geometry)
: returns numGeometries
¶
geometry
(Geometry
) requirednumGeometries
(Integer
)
numInteriorRing(geometry)
: returns numInteriorRing
¶
geometry
(Geometry
) requirednumInteriorRing
(Integer
)
numPoints(geometry)
: returns numPoints
¶
geometry
(Geometry
) requirednumPoints
(Integer
)
numberFormat(format, number, language)
: returns numberFormat
¶
format
(String
) requirednumber
(Number
) requiredlanguage
(String
) optionalnumberFormat
(String
)
numberFormat2(format, number, minus, decimal, separator)
: returns numberFormat2
¶
format
(String
) requirednumber
(Number
) requiredminus
(String
) requireddecimal
(String
) requiredseparator
(String
) requirednumberFormat2
(String
)
octagonalenvelope(geometry)
: returns octagonalenvelope
¶
geometry
(Geometry
) requiredoctagonalenvelope
(Geometry
)
offset(geometry, offsetX, offsetY)
: returns offset
¶
geometry
(Geometry
) requiredoffsetX
(Double
) requiredoffsetY
(Double
) requiredoffset
(Geometry
)
overlaps(geometry1, geometry2)
: returns overlaps
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredoverlaps
(Geometry
)
parseBoolean(string)
: returns parseBoolean
¶
string
(String
) requiredparseBoolean
(Boolean
)
parseDouble(string)
: returns parseDouble
¶
string
(String
) requiredparseDouble
(Double
)
parseInt(string)
: returns parseInt
¶
string
(String
) requiredparseInt
(Integer
)
parseLong(string)
: returns parseLong
¶
string
(String
) requiredparseLong
(Long
)
pgNearest(geometry, num_features)
: returns pgNearest
¶
geometry
(Geometry
) requirednum_features
(Integer
) requiredpgNearest
(Boolean
)
pi()
: returns pi
¶
pi
(Double
)
pointN(geometry, index)
: returns pointN
¶
geometry
(Geometry
) requiredindex
(Integer
) requiredpointN
(Geometry
)
pow(base, exponent)
: returns power
¶
base
(Number
) requiredexponent
(Number
) requiredpower
(Double
)
property(propertyName)
: returns propertyValue
¶
propertyName
(String
) requiredpropertyValue
random()
: returns random
¶
random
(Double
)
relate(geometry1, geometry2)
: returns relate
¶
geometry1
(Geometry
) requiredgeometry2
(Geometry
) requiredrelate
(String
)
rescaleToPixels(value, defaultUnit, scaleFactor, rescalingMode)
: returns rescaleToPixels
¶
value
(String
) requireddefaultUnit
(Unit
) requiredscaleFactor
(Double
) requiredrescalingMode
(RescalingMode
) optionalrescaleToPixels
(String
)
rint(double)
: returns rounded
¶
double
(Number
) requiredrounded
(Double
)
round(number)
: returns float
¶
number
(Number
) requiredfloat
(Float
)
roundDouble(number)
: returns rounded
¶
number
(Number
) requiredrounded
(Double
)
round_2(number)
: returns long
¶
number
(Number
) requiredlong
(Long
)
saturate(color, amount, method)
: returns result
¶
color
(Color
) requiredamount
(Float
) requiredmethod
(Method
) optionalresult
(Color
)
setCRS(geometry, CRS)
: returns setCRS
¶
geometry
(Geometry
) requiredCRS
(String
) requiredsetCRS
(Geometry
)
shade(color, weight)
: returns result
¶
color
(Color
) requiredweight
(Double
) requiredresult
(Color
)
sin(radians)
: returns sine
¶
radians
(Number
) requiredsine
(Double
)
size(source)
: returns result
¶
source
(Collection
) requiredresult
(Integer
)
spin(color, amount)
: returns result
¶
color
(Color
) requiredamount
(Double
) requiredresult
(Color
)
sqrt(number)
: returns root
¶
number
(Number
) requiredroot
(Double
)
startAngle(linestring)
: returns degrees
¶
linestring
(LineString
) requireddegrees
(Double
)
startPoint(linestring)
: returns point
¶
linestring
(LineString
) requiredpoint
(Point
)
strAbbreviate(string, lower, upper, appendTo)
: returns string
¶
string
(String
) requiredlower
(Integer
) requiredupper
(Integer
) requiredappendTo
(String
) requiredstring
(String
)
strCapitalize(string)
: returns string
¶
string
(String
) requiredstring
(String
)
strConcat(string1, string2)
: returns strConcat
¶
string1
(String
) requiredstring2
(String
) requiredstrConcat
(String
)
strDefaultIfBlank(string, default)
: returns string
¶
string
(String
) requireddefault
(String
) requiredstring
(String
)
strEndsWith(String, postfix)
: returns endsWith
¶
String
(String
) requiredpostfix
(String
) requiredendsWith
(Boolean
)
strEqualsIgnoreCase(string, lookup)
: returns equals
¶
string
(String
) requiredlookup
(String
) requiredequals
(Boolean
)
strIndexOf(String, lookup)
: returns index
¶
String
(String
) requiredlookup
(String
) requiredindex
(Integer
)
strLastIndexOf(String, lookup)
: returns index
¶
String
(String
) requiredlookup
(String
) requiredindex
(Integer
)
strLength(string)
: returns length
¶
string
(String
) requiredlength
(Integer
)
strMatches(string, regex)
: returns match
¶
string
(String
) requiredregex
(String
) requiredmatch
(Boolean
)
strPosition(string, lookup, method)
: returns string
¶
string
(String
) requiredlookup
(String
) requiredmethod
(String
) requiredstring
(String
)
strReplace(string, search, replace, all)
: returns string
¶
string
(String
) requiredsearch
(String
) requiredreplace
(String
) requiredall
(Boolean
) requiredstring
(String
)
strStartsWith(string, prefix)
: returns starts with
¶
string
(String
) requiredprefix
(String
) requiredstarts with
(Boolean
)
strStripAccents(string)
: returns string
¶
string
(String
) requiredstring
(String
)
strSubstring(string, beginIndex, endIndex)
: returns substring
¶
string
(String
) requiredbeginIndex
(Integer
) requiredendIndex
(Integer
) requiredsubstring
(String
)
strSubstringStart(string, beginIndex)
: returns substring
¶
string
(String
) requiredbeginIndex
(Integer
) requiredsubstring
(String
)
strToLowerCase(string)
: returns lowercase
¶
string
(String
) requiredlowercase
(String
)
strToUpperCase(string)
: returns uppercase
¶
string
(String
) requireduppercase
(String
)
strTrim(string)
: returns trim
¶
string
(String
) requiredtrim
(String
)
strTrim2(string, method, character)
: returns trim
¶
string
(String
) requiredmethod
(String
) requiredcharacter
(String
) requiredtrim
(String
)
strURLEncode(encodeable, formUrlEncode)
: returns strURLEncode
¶
encodeable
(String
) requiredformUrlEncode
(Boolean
) optionalstrURLEncode
(String
)
stringTemplate(input, pattern, template, defaultValue)
: returns return
¶
input
pattern
template
defaultValue
return
symDifference(geometry, geometry)
: returns symetric difference
¶
geometry
(Geometry
) requiredgeometry
(Geometry
) requiredsymetric difference
(Geometry
)
tan(radians)
: returns tan
¶
radians
(Number
) requiredtan
(Double
)
tint(color, weight)
: returns result
¶
color
(Color
) requiredweight
(Double
) requiredresult
(Color
)
toDegrees(radians)
: returns degrees
¶
radians
(Number
) requireddegrees
(Double
)
toRadians(degree)
: returns radians
¶
degree
(Number
) requiredradians
(Double
)
toWKT(geometry)
: returns wkt
¶
geometry
(Geometry
) requiredwkt
(String
)
touches(geometry, geometry)
: returns touches
¶
geometry
(Geometry
) requiredgeometry
(Geometry
) requiredtouches
(Boolean
)
union(geometry, geometry)
: returns union
¶
geometry
(Geometry
) requiredgeometry
(Geometry
) requiredunion
(Geometry
)
vertices(geometry)
: returns vertices
¶
geometry
(Geometry
) requiredvertices
(MultiPoint
)
within(geometry, geometry)
: returns within
¶
geometry
(Geometry
) requiredgeometry
(Geometry
) requiredwithin
(Boolean
)
ProcessFunctionFactory
¶
Contains 102 functions.
AddCoverages(coverageA, coverageB)
: returns result
¶
coverageA
(GridCoverage2D
) requiredcoverageB
(GridCoverage2D
) requiredresult
(GridCoverage2D
)
Affine(coverage, scalex, scaley, shearx, sheary, translatex, translatey, nodata, interpolation)
: returns result
¶
coverage
(GridCoverage2D
) requiredscalex
(Double
) optionalscaley
(Double
) optionalshearx
(Double
) optionalsheary
(Double
) optionaltranslatex
(Double
) optionaltranslatey
(Double
) optionalnodata
(double
)interpolation
(Interpolation
) optionalresult
(GridCoverage2D
)
Aggregate(features, aggregationAttribute, function, singlePass, groupByAttributes)
: returns result
¶
features
(SimpleFeatureCollection
) requiredaggregationAttribute
(String
) optionalfunction
(AggregationFunction
)singlePass
(Boolean
) requiredgroupByAttributes
(String
)result
(Results
)
AreaGrid(envelope, width, height)
: returns result
¶
envelope
(ReferencedEnvelope
) requiredwidth
(Integer
) requiredheight
(Integer
) requiredresult
(GridCoverage2D
)
BandMerge(coverages, roi, transformChoice, index)
: returns result
¶
coverages
(GridCoverage2D
) requiredroi
(Geometry
) optionaltransformChoice
(String
) optionalindex
(Integer
) optionalresult
(GridCoverage2D
)
BandSelect(coverage, SampleDimensions, VisibleSampleDimension)
: returns result
¶
coverage
(GridCoverage2D
) requiredSampleDimensions
(int
) requiredVisibleSampleDimension
(Integer
) optionalresult
(GridCoverage2D
)
BarnesSurface(data, valueAttr, dataLimit, scale, convergence, passes, minObservations, maxObservationDistance, noDataValue, pixelsPerCell, queryBuffer, outputBBOX, outputWidth, outputHeight)
: returns result
¶
data
(SimpleFeatureCollection
) requiredvalueAttr
(String
) requireddataLimit
(Integer
) optionalscale
(Double
) requiredconvergence
(Double
) optionalpasses
(Integer
) optionalminObservations
(Integer
) optionalmaxObservationDistance
(Double
) optionalnoDataValue
(Double
) optionalpixelsPerCell
(Integer
) optionalqueryBuffer
(Double
) optionaloutputBBOX
(ReferencedEnvelope
) requiredoutputWidth
(Integer
) requiredoutputHeight
(Integer
) requiredresult
(GridCoverage2D
)
Bounds(features)
: returns bounds
¶
features
(FeatureCollection
) requiredbounds
(ReferencedEnvelope
)
BufferFeatureCollection(features, distance, attributeName)
: returns result
¶
features
(SimpleFeatureCollection
) requireddistance
(Double
) requiredattributeName
(String
) optionalresult
(SimpleFeatureCollection
)
Centroid(features)
: returns result
¶
features
(SimpleFeatureCollection
) requiredresult
(SimpleFeatureCollection
)
ClassifyByRange(features, classifyOnAttribute, thresholds, outputValues, classifier, classes, include, outputAttribute, outputType)
: returns result
¶
features
(SimpleFeatureCollection
) requiredclassifyOnAttribute
(String
) requiredthresholds
(String
)outputValues
(String
)classifier
(String
) optionalclasses
(Integer
) optionalinclude
(Boolean
) optionaloutputAttribute
(String
) optionaloutputType
(String
) optionalresult
(SimpleFeatureCollection
)
Clip(features, clip, preserveZ)
: returns result
¶
features
(SimpleFeatureCollection
) requiredclip
(Geometry
) requiredpreserveZ
(Boolean
) optionalresult
(SimpleFeatureCollection
)
CollectGeometries(features)
: returns result
¶
features
(FeatureCollection
) requiredresult
(GeometryCollection
)
Contour(data, band, levels, interval, simplify, smooth, roi)
: returns result
¶
data
(GridCoverage2D
) requiredband
(Integer
) optionallevels
(double
)interval
(Double
) optionalsimplify
(Boolean
) optionalsmooth
(Boolean
) optionalroi
(Geometry
) optionalresult
(SimpleFeatureCollection
)
ConvolveCoverage(data, kernel, kernelRadius, kernelWidth, kernelHeight)
: returns result
¶
data
(GridCoverage2D
) requiredkernel
(KernelJAI
) optionalkernelRadius
(Integer
) optionalkernelWidth
(Integer
) optionalkernelHeight
(Integer
) optionalresult
(GridCoverage2D
)
Count(features)
: returns result
¶
features
(SimpleFeatureCollection
) requiredresult
(Number
)
CoverageClassStats(coverage, stats, band, classes, method, noData)
: returns results
¶
coverage
(GridCoverage2D
) requiredstats
(Statistic
)band
(Integer
) optionalclasses
(Integer
) optionalmethod
(ClassificationMethod
) optionalnoData
(Double
) optionalresults
(Results
)
CropCoverage(coverage, cropShape)
: returns result
¶
coverage
(GridCoverage2D
) requiredcropShape
(Geometry
) requiredresult
(GridCoverage2D
)
Feature(geometry, crs, typeName)
: returns result
¶
geometry
(Geometry
) requiredcrs
(CoordinateReferenceSystem
) requiredtypeName
(String
) requiredresult
(SimpleFeatureCollection
)
FeatureClassStats(features, attribute, stats, classes, method, noData)
: returns results
¶
features
(FeatureCollection
) requiredattribute
(String
) requiredstats
(Statistic
)classes
(Integer
) optionalmethod
(ClassificationMethod
) optionalnoData
(Double
) optionalresults
(Results
)
Grid(bounds, width, height, vertexSpacing, mode)
: returns result
¶
bounds
(ReferencedEnvelope
) requiredwidth
(Double
) requiredheight
(Double
) optionalvertexSpacing
(Double
) optionalmode
(GridMode
) requiredresult
(SimpleFeatureCollection
)
Heatmap(data, radiusPixels, weightAttr, pixelsPerCell, outputBBOX, outputWidth, outputHeight)
: returns result
¶
data
(SimpleFeatureCollection
) requiredradiusPixels
(Integer
) requiredweightAttr
(String
) optionalpixelsPerCell
(Integer
) optionaloutputBBOX
(ReferencedEnvelope
) requiredoutputWidth
(Integer
) requiredoutputHeight
(Integer
) requiredresult
(GridCoverage2D
)
InclusionFeatureCollection(first, second)
: returns result
¶
first
(SimpleFeatureCollection
) requiredsecond
(SimpleFeatureCollection
) requiredresult
(SimpleFeatureCollection
)
IntersectionFeatureCollection(first feature collection, second feature collection, first attributes to retain, second attributes to retain, intersectionMode, percentagesEnabled, areasEnabled)
: returns result
¶
first feature collection
(SimpleFeatureCollection
) requiredsecond feature collection
(SimpleFeatureCollection
) requiredfirst attributes to retain
(String
)second attributes to retain
(String
)intersectionMode
(IntersectionMode
) optionalpercentagesEnabled
(Boolean
) optionalareasEnabled
(Boolean
) optionalresult
(SimpleFeatureCollection
)
Jiffle(coverage, script, destName, sourceName, outputType)
: returns result
¶
coverage
(GridCoverage2D
)script
(String
) requireddestName
(String
) optionalsourceName
(String
)outputType
(DataType
) optionalresult
(GridCoverage2D
)
LRSGeocode(features, from_measure_attb, to_measure_attb, measure)
: returns result
¶
features
(FeatureCollection
) requiredfrom_measure_attb
(String
) requiredto_measure_attb
(String
) requiredmeasure
(Double
) requiredresult
(FeatureCollection
)
LRSMeasure(features, from_measure_attb, to_measure_attb, point, crs)
: returns result
¶
features
(FeatureCollection
) requiredfrom_measure_attb
(String
) requiredto_measure_attb
(String
) requiredpoint
(Point
) requiredcrs
(CoordinateReferenceSystem
) optionalresult
(FeatureCollection
)
LRSSegment(features, from_measure_attb, to_measure_attb, from_measure, to_measure)
: returns result
¶
features
(FeatureCollection
) requiredfrom_measure_attb
(String
) requiredto_measure_attb
(String
) requiredfrom_measure
(Double
) requiredto_measure
(Double
) requiredresult
(FeatureCollection
)
MultiplyCoverages(coverageA, coverageB)
: returns result
¶
coverageA
(GridCoverage2D
) requiredcoverageB
(GridCoverage2D
) requiredresult
(GridCoverage2D
)
Nearest(features, point, crs)
: returns result
¶
features
(FeatureCollection
) requiredpoint
(Point
) requiredcrs
(CoordinateReferenceSystem
) optionalresult
(FeatureCollection
)
NormalizeCoverage(data)
: returns result
¶
data
(GridCoverage2D
) requiredresult
(GridCoverage2D
)
PointBuffers(center, crs, distances, quadrantSegments)
: returns buffers
¶
center
(Point
) requiredcrs
(CoordinateReferenceSystem
) optionaldistances
(double
)quadrantSegments
(Integer
) optionalbuffers
(SimpleFeatureCollection
)
PointStacker(data, cellSize, weightClusterPosition, normalize, preserveLocation, outputBBOX, outputWidth, outputHeight)
: returns result
¶
data
(SimpleFeatureCollection
) requiredcellSize
(Integer
) requiredweightClusterPosition
(Boolean
) requirednormalize
(Boolean
) requiredpreserveLocation
(PreserveLocation
) optionaloutputBBOX
(ReferencedEnvelope
) requiredoutputWidth
(Integer
) requiredoutputHeight
(Integer
) requiredresult
(SimpleFeatureCollection
)
PolyLabeller(polygon, precision)
: returns result
¶
polygon
(Geometry
) requiredprecision
(Double
) requiredresult
(Geometry
)
PolygonExtraction(data, band, insideEdges, roi, nodata, ranges)
: returns result
¶
data
(GridCoverage2D
) requiredband
(Integer
) optionalinsideEdges
(Boolean
) optionalroi
(Geometry
) optionalnodata
(Number
)ranges
(Range
)result
(SimpleFeatureCollection
)
Query(features, attribute, filter)
: returns result
¶
features
(SimpleFeatureCollection
) requiredattribute
(String
)filter
(Filter
) optionalresult
(SimpleFeatureCollection
)
RangeLookup(coverage, band, ranges, outputPixelValues, noData)
: returns reclassified
¶
coverage
(GridCoverage2D
) requiredband
(Integer
) optionalranges
(Range
)outputPixelValues
(int
)noData
(Double
) optionalreclassified
(GridCoverage2D
)
RasterAsPointCollection(data, targetCRS, scale, interpolation, emisphere)
: returns result
¶
data
(GridCoverage2D
) requiredtargetCRS
(CoordinateReferenceSystem
) optionalscale
(Float
) optionalinterpolation
(Interpolation
) optionalemisphere
(Boolean
) optionalresult
(SimpleFeatureCollection
)
RasterZonalStatistics(data, band, zones, classification)
: returns statistics
¶
data
(GridCoverage2D
) requiredband
(Integer
) optionalzones
(SimpleFeatureCollection
) requiredclassification
(GridCoverage2D
) optionalstatistics
(SimpleFeatureCollection
)
RasterZonalStatistics2(source, bands, zones, classifier, nodata, mask, useROIAccessor, roi, statistics, minbounds, maxbounds, numbins, rangeData, localStats)
: returns zonal statistics
¶
source
(GridCoverage2D
) requiredbands
(int
)zones
(Object
)classifier
(GridCoverage2D
) optionalnodata
(Range
) requiredmask
(Geometry
) requireduseROIAccessor
(Boolean
) requiredroi
(Polygon
) requiredstatistics
(StatsType
)minbounds
(double
)maxbounds
(double
)numbins
(int
)rangeData
(Object
)localStats
(Boolean
) requiredzonal statistics
(List
)
RectangularClip(features, clip, preserveZ)
: returns result
¶
features
(SimpleFeatureCollection
) requiredclip
(ReferencedEnvelope
) requiredpreserveZ
(Boolean
) optionalresult
(SimpleFeatureCollection
)
Reproject(features, forcedCRS, targetCRS)
: returns result
¶
features
(SimpleFeatureCollection
) requiredforcedCRS
(CoordinateReferenceSystem
) optionaltargetCRS
(CoordinateReferenceSystem
) optionalresult
(SimpleFeatureCollection
)
ScaleCoverage(coverage, xScale, yScale, xTranslate, yTranslate, interpolation)
: returns result
¶
coverage
(GridCoverage2D
) requiredxScale
(Double
) requiredyScale
(Double
) requiredxTranslate
(Double
) requiredyTranslate
(Double
) requiredinterpolation
(Interpolation
) optionalresult
(GridCoverage2D
)
Simplify(features, distance, preserveTopology)
: returns result
¶
features
(SimpleFeatureCollection
) requireddistance
(Double
) requiredpreserveTopology
(Boolean
) requiredresult
(SimpleFeatureCollection
)
Snap(features, point, crs)
: returns result
¶
features
(FeatureCollection
) requiredpoint
(Point
) requiredcrs
(CoordinateReferenceSystem
) optionalresult
(FeatureCollection
)
StyleCoverage(coverage, style)
: returns result
¶
coverage
(GridCoverage2D
) requiredstyle
(Style
) requiredresult
(GridCoverage2D
)
Transform(features, transform)
: returns result
¶
features
(SimpleFeatureCollection
) requiredtransform
(String
) requiredresult
(SimpleFeatureCollection
)
TransparencyFill(data, width)
: returns result
¶
data
(GridCoverage2D
) requiredwidth
(Integer
) optionalresult
(GridCoverage2D
)
UnionFeatureCollection(first, second)
: returns result
¶
first
(SimpleFeatureCollection
) requiredsecond
(SimpleFeatureCollection
) requiredresult
(SimpleFeatureCollection
)
Unique(features, attribute)
: returns result
¶
features
(SimpleFeatureCollection
) requiredattribute
(String
) requiredresult
(SimpleFeatureCollection
)
VectorToRaster(features, rasterWidth, rasterHeight, title, attribute, bounds)
: returns result
¶
features
(SimpleFeatureCollection
) requiredrasterWidth
(Integer
) requiredrasterHeight
(Integer
) requiredtitle
(String
) optionalattribute
(String
) requiredbounds
(Envelope
) optionalresult
(GridCoverage2D
)
VectorZonalStatistics(data, dataAttribute, zones)
: returns statistics
¶
data
(SimpleFeatureCollection
) requireddataAttribute
(String
) requiredzones
(SimpleFeatureCollection
) requiredstatistics
(SimpleFeatureCollection
)
area(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(double
)
boundary(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
buffer(geom, distance, quadrantSegments, capStyle)
: returns result
¶
geom
(Geometry
) requireddistance
(Double
) requiredquadrantSegments
(Integer
) optionalcapStyle
(BufferCapStyle
) optionalresult
(Geometry
)
centroid(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
contains(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
convexHull(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
crosses(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
densify(geom, distance)
: returns result
¶
geom
(Geometry
) requireddistance
(Double
) requiredresult
(Geometry
)
difference(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(Geometry
)
dimension(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(int
)
disjoint(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
distance(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(double
)
endPoint(geom)
: returns result
¶
geom
(LineString
) requiredresult
(Point
)
envelope(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
equalsExact(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
equalsExactTolerance(a, b, tolerance)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredtolerance
(Double
) requiredresult
(boolean
)
exteriorRing(geom)
: returns result
¶
geom
(Polygon
) requiredresult
(Geometry
)
geometryType(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(String
)
getGeometryN(geom, index)
: returns result
¶
geom
(GeometryCollection
) requiredindex
(Integer
) requiredresult
(Geometry
)
getX(geom)
: returns result
¶
geom
(Point
) requiredresult
(double
)
getY(geom)
: returns result
¶
geom
(Point
) requiredresult
(double
)
interiorPoint(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
interiorRingN(geom, index)
: returns result
¶
geom
(Polygon
) requiredindex
(Integer
) requiredresult
(Geometry
)
intersection(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(Geometry
)
intersects(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
isClosed(geom)
: returns result
¶
geom
(LineString
) requiredresult
(boolean
)
isEmpty(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(boolean
)
isRing(geom)
: returns result
¶
geom
(LineString
) requiredresult
(boolean
)
isSimple(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(boolean
)
isValid(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(boolean
)
isWithinDistance(a, b, distance)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requireddistance
(Double
) requiredresult
(boolean
)
length(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(double
)
numGeometries(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(int
)
numInteriorRing(geom)
: returns result
¶
geom
(Polygon
) requiredresult
(int
)
numPoints(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(int
)
octagonalEnvelope(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
overlaps(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
parameter(argumentName, values)
: returns parameterMap
¶
argumentName
(String
) requiredvalues
(Object
)parameterMap
(Map
)
pointN(geom, index)
: returns result
¶
geom
(LineString
) requiredindex
(Integer
) requiredresult
(Point
)
polygonize(geom)
: returns result
¶
geom
(Geometry
) requiredresult
(Geometry
)
relate(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(String
)
relatePattern(a, b, Relate pattern)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredRelate pattern
(String
) requiredresult
(boolean
)
reproject(geometry, sourceCRS, targetCRS)
: returns result
¶
geometry
(Geometry
) requiredsourceCRS
(CoordinateReferenceSystem
) optionaltargetCRS
(CoordinateReferenceSystem
) optionalresult
(Geometry
)
simplify(geom, distance)
: returns result
¶
geom
(Geometry
) requireddistance
(Double
) requiredresult
(Geometry
)
splitPolygon(polygon, line)
: returns result
¶
polygon
(Geometry
) requiredline
(LineString
) requiredresult
(Geometry
)
startPoint(geom)
: returns result
¶
geom
(LineString
) requiredresult
(Point
)
symDifference(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(Geometry
)
touches(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
union(geom)
: returns result
¶
geom
(Geometry
): min=2 max=unboundedresult
(Geometry
)
within(a, b)
: returns result
¶
a
(Geometry
) requiredb
(Geometry
) requiredresult
(boolean
)
PolygonLabelFunctionFactory
¶
Contains 1 functions.
labelPoint(polygon, tolerance)
: returns labelPoint
¶
polygon
(Geometry
) requiredtolerance
(double
) requiredlabelPoint
(Point
)