QGIS/resources/function_help/json/triangular_wave

{
  "name": "triangular_wave",
  "type": "function",
  "groups": ["GeometryGroup"],
  "description": "Constructs triangular waves along the boundary of a geometry.",
  "arguments": [{
    "arg": "geometry",
    "description": "a geometry"
  }, {
    "arg": "wavelength",
    "description": "wavelength of triangular waveform"
  }, {
    "arg": "amplitude",
    "description": "amplitude of triangular waveform"
  }, {
    "arg": "strict",
    "optional": true,
    "default": false,
    "description": "By default the wavelength argument is treated as a \"maximum wavelength\", where the actual wavelength will be dynamically adjusted so that an exact number of triangular waves are created along the boundaries of the geometry. If the strict argument is set to true then the wavelength will be used exactly and an incomplete pattern may be used for the final waveform."
  }],
  "examples": [{
    "expression": "triangular_wave(geom_from_wkt('LineString(0 0, 10 0)'), 3, 1)",
    "returns": "Triangular waves with wavelength 3 and amplitude 1 along the linestring"
  }],
  "tags": ["waves", "boundary", "constructs", "triangular"]
}