docs: inform users that some expression functions are deprecated

This commit is contained in:
Antoine Facchini 2022-11-10 09:54:45 +01:00
parent d8131a0791
commit 77e9491329
5 changed files with 5 additions and 5 deletions

View File

@ -2,7 +2,7 @@
"name": "$x",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the x coordinate of the current point feature. If the feature is a multipoint feature, then the x-coordinate of the first point will be returned.",
"description": "Returns the x coordinate of the current point feature. If the feature is a multipoint feature, then the x-coordinate of the first point will be returned. <b>WARNING: This function is deprecated. It is recommended to use the replacement x() function with @geometry variable instead.</b>",
"examples": [{
"expression": "$x",
"returns": "42"

View File

@ -2,7 +2,7 @@
"name": "$x_at",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Retrieves a x coordinate of the current feature's geometry.",
"description": "Retrieves a x coordinate of the current feature's geometry. <b>WARNING: This function is deprecated. It is recommended to use the replacement x_at function with @geometry variable instead.</b>",
"arguments": [{
"arg": "i",
"description": "index of point of a line (indices start at 0; negative values apply from the last index, starting at -1)"

View File

@ -2,7 +2,7 @@
"name": "$y",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the y coordinate of the current point feature. If the feature is a multipoint feature, then the y-coordinate of the first point will be returned.",
"description": "Returns the y coordinate of the current point feature. If the feature is a multipoint feature, then the y-coordinate of the first point will be returned. <b>WARNING: This function is deprecated. It is recommended to use the replacement y() function with @geometry variable instead.</b>",
"examples": [{
"expression": "$y",
"returns": "42"

View File

@ -2,7 +2,7 @@
"name": "$y_at",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Retrieves a y coordinate of the current feature's geometry.",
"description": "Retrieves a y coordinate of the current feature's geometry. <b>WARNING: This function is deprecated. It is recommended to use the replacement y_at function with @geometry variable instead.</b>",
"arguments": [{
"arg": "i",
"description": "index of point of a line (indices start at 0; negative values apply from the last index, starting at -1)"

View File

@ -2,7 +2,7 @@
"name": "$z",
"type": "function",
"groups": ["GeometryGroup"],
"description": "Returns the z value of the current point feature if it is 3D. If the feature is a multipoint feature, then the z value of the first point will be returned.",
"description": "Returns the z value of the current point feature if it is 3D. If the feature is a multipoint feature, then the z value of the first point will be returned. <b>WARNING: This function is deprecated. It is recommended to use the replacement z() function with @geometry variable instead.</b>",
"examples": [{
"expression": "$z",
"returns": "123"