calqulus-pipeline.schema.json

line_endings: unix

title: Qualisys Calqulus Pipeline

description: A document describing calculations to be done on biomechanical data for presentation in a report.

$ref: #/$defs/Parameter Node

$ref: #/$defs/Space Node

$ref: #/$defs/Event Node

$ref: #/$defs/Marker Node

$ref: #/$defs/Segment Node

title: Parameter node

description: A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.

title: Space node

title: Event node

title: Marker node

title: Marker node

title: Node steps

description: A step node takes an input and some options and outputs a value.

title: Step: angle

description:
The angle step performs slightly different operation depending on the type and number of inputs.

Note: _For cases where multiple inputs are given of varying lengths, the returning array will be the maximum length and the last value will be repeated for the shorter inputs to fill the gap._

One input: `` Computes the euler angle of the specified segment, in degrees.

Two inputs: (, ) | (, ) Given two segments: Computes the relative (euler) angle between the specified segments, in degrees.

Given two vectors: Computes relative angle between the specified vectors, in radians.

Three inputs: , ,  Computes the angle between the two vectors defined by the specified points (v0 -> v1, v1 -> v2), in radians. The points can be specified as arrays or with named vector signals (ie markers).

Given the inputs v1, v2 and v3, the resulting angle is given by:

angleBetween(v1 - v0, v1 - v2)

Four inputs: , , ,  Computes the angle between the two lines formed by (v0 -> v1, v2 -> v3), in radians. The points can be specified as arrays or with named vector signals (ie markers).

title: angle step

type: string array null

$ref: #/$defs/globalOption export

$ref: #/$defs/globalOption set

$ref: #/$defs/globalOption space

$ref: #/$defs/categoryOption Angle project

$ref: #/$defs/categoryOption Angle unwrap

title: Step: angularVelocity

description:
This step calculates the joint angular velocity based on the textbook Research Methods in Biomechanics (2nd Edition).

You can visit http://www.kwon3d.com/theory/euler/avel.html for more details.

This is different from calculating the first-order derivate of the joint angle because each axis of the joint angle are different from the axes of the segment coordinate systems.

**Please consider which implementation would be correct to use in your instance**.

title: angularVelocity step

title: angularVelocity > useRotationOrder

description:
If set to false it means that the angular velocity between the segment and refernce segment is transformed to be expressed into the resolution coordinate system.

If set to true it means that angular velocity between the segment and refernce segment is transformed to be expressed into the joint coordinate system using the Euler/Cardan sequence.

type: string boolean

title: Step: jointAngle

description: Performs the same computation as angle, but does not handle three or four inputs.

title: jointAngle step

description: Performs the same computation as angle, but does not handle three or four inputs.

title: Step: jointAngleVelocity

description: Performs the same computation as angularVelocity.

title: jointAngleVelocity step

description: Performs the same computation as angularVelocity.

title: jointAngleVelocity > useRotationOrder

title: Step: count

description: Counts the number of values in the input, i.e. the number of frames in a series, or the number of values in a scalar or event input.

title: count step

description: Counts the number of values in the input, i.e. the number of frames in a series, or the number of values in a scalar or event input.

title: Step: max

description: Outputs the max value of the input.

title: max step

description: Outputs the max value of the input.

title: max > frames

description: If set to true, this step returns the frame index for the maximum value of the input. If using cycles, it will return a frame per cycle.

title: Step: mean

description: Outputs the mean value of the input.

title: mean step

description: Outputs the mean value of the input.

title: Step: median

description: Outputs the median value of the input.

title: median step

description: Outputs the median value of the input.

title: Step: min

description: Outputs the minimum value of the input.

title: min step

description: Outputs the minimum value of the input.

title: min > frames

description: If set to true, this step returns the frame index for the minimum value of the input. If using cycles, it will return a frame per cycle.

title: Step: range

description: Outputs the range between the minimum and maximum value of the input.

title: range step

description: Outputs the range between the minimum and maximum value of the input.

title: Step: rms

description: Outputs the Root Mean Square (root of the average squared deviations) between two arrays.

title: rms step

description: Outputs the Root Mean Square (root of the average squared deviations) between two arrays.

title: Step: standardDeviation

description: Outputs the standard deviation value of the input.

title: standardDeviation step

description: Outputs the standard deviation value of the input.

title: Step: standardDeviation

description: Outputs the standard deviation value of the input.

title: stdDev step

description: Outputs the standard deviation value of the input.

title: Step: sum

description: Outputs the sum of all values of the input.

title: sum step

description: Outputs the sum of all values of the input.

title: Step: add

description: Adds the input operands.

title: add step

description: Adds the input operands.

title: Step: divide

description: Divides the input operands.

title: divide step

description: Divides the input operands.

title: Step: multiply

description: Multiplies the input operands.

title: multiply step

description: Multiplies the input operands.

title: Step: subtract

description: Subtracts the input operands.

title: subtract step

description: Subtracts the input operands.

title: Step: distance

description:
Accepts marker or segment sequences and calculates the distance between the points (Euclidian norm).

It assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.

title: distance step

title: Step: magnitude

description: Accepts a vector or a segment sequence and calculates the magnitude of it (Euclidian norm).

title: magnitude step

description: Accepts a vector or a segment sequence and calculates the magnitude of it (Euclidian norm).

title: Step: plane

description:
Takes three marker or segment sequences and returns the plane which intersects all three points.

It assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.

title: plane step

title: Step: project

description:
Orthogonally projects a point onto a plane and returns the location of the projected point.

Note: *The plane will remain in the space used when creating it, applying a space to the project step will apply the space to the vector / segment, but the plane will be left untouched.*

title: project step

title: Step: unitVector

description: Calculates the unit vector i.e. the new vector has the same direction of the input vector but its norm equals 1.

title: unitVector step

description: Calculates the unit vector i.e. the new vector has the same direction of the input vector but its norm equals 1.

title: Step: abs

description: Outputs the absolute value for each value in the input signal.

title: abs step

description: Outputs the absolute value for each value in the input signal.

title: Step: convert

description: For each value of the input, converts it according to the units defined in the from and to options.

title: convert step

description: For each value of the input, converts it according to the units defined in the from and to options.

title: convert > from

description: Defines the unit to convert from.

title: convert > to

description: Defines the unit to convert to.

title: Step: diff

description: Outputs the difference between each value in the input. Since this compares value n with n+1, the output signal will be shorter by one item.

title: diff step

description: Outputs the difference between each value in the input. Since this compares value n with n+1, the output signal will be shorter by one item.

title: Step: dotProduct

description:
Calculates the dot product between two vectors.

The output length will be equal to the length of the first vector sequence.

The second vector sequence needs to be singular or equal to the first vector sequence in length.

A lone vector in the second input will be used to calculate the dot product between itself and all vectors contained in the first vector sequence.

title: dotProduct step

title: Step: dotProduct

title: dot step

title: Step: gapFill

description:
Outputs a resulting signal of the same type as the input signal where gaps are filled using interpolation.

Note: *Gaps at the beginning or end of the signal will not be interpolated.*

title: gapFill step

description:
Outputs a resulting signal of the same type as the input signal where gaps are filled using interpolation.

Note: *Gaps at the beginning or end of the signal will not be interpolated.*

title: gapFill > type

title: gapFill > maxGapLength

title: Step: integral

description: Returns the cumulative integral between neighboring frames in a data series, using the trapezoidal rule. It returns a series by default.

title: integral step

description: Returns the cumulative integral between neighboring frames in a data series, using the trapezoidal rule. It returns a series by default.

title: integral > scalar

description: Returns the integral as a single value scalar.

title: integral > useCycles

description:
If the signal has cycles defined, the integral step will be run separately over each signal, and a list of values are returned, one for each cycle.

To avoid this behaviour, set useCycles to false.

For information on how to set event cycles on a signal, see the eventMask step.

title: Step: negate

description: Outputs the negated value for each value in the input signal.

title: negate step

description: Outputs the negated value for each value in the input signal.

title: Step: round

description:
Outputs a resulting signal of the same type as the input signal where every value is rounded to the specific precision.

The precision is specified as the number of decimal places to include in the result.

title: round step

title: round > precision

title: Step: acceleration

description:
Derives the input signal to the second order.

Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._

Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._

title: acceleration step

title: Step: derivative

description:
Derives the input signal to the order defined in input 2. If input 2 is not set, the signal is derived to order 1.

Only the first and second order is supported.

Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._

Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._

title: derivative step

title: Step: velocity

description:
Derives the input signal to the first order.

Note: _Due to the temporal nature of this operation, the resulting first and last frame will be null._

Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._

title: velocity step

title: Step: highpass

description: Runs a Butterworth IIR high-pass filter over the input data.

title: highpass step

description: Runs a Butterworth IIR high-pass filter over the input data.

title: highpass > extrapolate

description:
Extrapolation buffer. Defines how many frames to add on either side of the series, useful if the filter handles the edges of the series strangely.

Leading and trailing NaN values are removed before extrapolation, i.e., extrapolation begins from the first and last real value. NaN values are then re-inserted in the original places for the output.

Extrapolation is made by looking at the first and second values, and the last and second-to-last values, respectively. The buffer is then filled with values linearly extrapolated from these two points.

title: highpass > iterations

description: Defines how many times to apply the filter in sequence. If the iterations is set to anything other than 1, the filter will be applied multiple times, using the output of the previous iteration as the input for the next.

title: highpass > cutoff

description: Defines around what frequency to limit the filter. The filter will attenuate frequencies below this value.

title: highpass > order

description: Defines the filter order. The higher the order, the steeper the attenuation slope will be.

title: Step: lowpass

description: Runs a Butterworth IIR low-pass filter over the input data.

title: lowpass step

description: Runs a Butterworth IIR low-pass filter over the input data.

title: lowpass > extrapolate

title: lowpass > iterations

title: lowpass > cutoff

description: Defines around what frequency to limit the filter. The filter will attenuate frequencies above this value.

title: lowpass > order

description: Defines the filter order. The higher the order, the steeper the attenuation slope will be.

title: Step: acos

description: Outputs the arc cosine (or inverse cosine) for each value in the input signal.

title: acos step

description: Outputs the arc cosine (or inverse cosine) for each value in the input signal.

title: Step: asin

description: Outputs the arcsine (or inverse sine) for each value in the input signal.

title: asin step

description: Outputs the arcsine (or inverse sine) for each value in the input signal.

title: Step: atan

description: Outputs the arctangent (or inverse sine) for each value in the input signal.

title: atan step

description: Outputs the arctangent (or inverse sine) for each value in the input signal.

title: Step: atan2

description: Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.

title: atan2 step

description: Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.

title: Step: cos

description: Outputs the cosine for each value in the input signal.

title: cos step

description: Outputs the cosine for each value in the input signal.

title: Step: cosh

description: Outputs the hyperbolic cosine for each value in the input signal.

title: cosh step

description: Outputs the hyperbolic cosine for each value in the input signal.

title: Step: cotan

description: Outputs the cotangent for each value in the input signal.

title: cotan step

description: Outputs the cotangent for each value in the input signal.

title: Step: sin

description: Outputs the sine for each value in the input signal.

title: sin step

description: Outputs the sine for each value in the input signal.

title: Step: sinh

description: Outputs the hyperbolic sine for each value in the input signal.

title: sinh step

description: Outputs the hyperbolic sine for each value in the input signal.

title: Step: tan

description: Outputs the tangent for each value in the input signal.

title: tan step

description: Outputs the tangent for each value in the input signal.

title: Step: tanh

description: Outputs the hyperbolic tangent for each value in the input signal.

title: tanh step

description: Outputs the hyperbolic tangent for each value in the input signal.

title: Step: if

description:
Runs a logical expression. The return value is determined by the result of the expression, and the then and else options.

The following operators are supported:

  >=

Parentheses can be used to influence the order of evaluation.

Only numbers and single-element arrays can be part of the expression.

title: if step

title: if > then

title: if > else

title: Step: event

description: Imports an event by name.

title: event step

description: Imports an event by name.

title: Step: import

description: Generic import of any input by name.

title: import step

description: Generic import of any input by name.

title: Step: marker

description: Imports a marker series by name or creates a new signal with a custom origin.

title: marker step

description: Imports a marker series by name or creates a new signal with a custom origin.

title: marker > origin

description: This option can be used to create a new marker signal, with a custom x, y and z coordinate.

title: Step: segment

description: Imports a segment series by name.

title: segment step

description: Imports a segment series by name.

title: Step: eventDuration

description:
This step takes 2 event inputs and outputs an array of durations (in seconds).

Inputs 1 and 2 will be combined into pairs - from values in input 1 to values in input 2.

The duration is calculated using the frame rate from either the "from", or "to" input event.

title: eventDuration step

title: Step: eventMask

description:
This is a step which takes a signal and 2 event inputs and outputs a filtered signal with values only appearing in between the events.

Inputs 2 and 3 will be combined into pairs from values in input 2 to values in input 3.

These pairs can be used to filter the values in input 1.

These event pairs, or cycles are also stored on the resulting signal, which can be used in aggregations to aggregate over event cycles. The signal will keep the cycle information no matter if the signal was truncated or not.

If the signal input is an event, only event frames that is within the span of one of the event pairs will be returned.

The optional parameter replacement will, if set, replace masked values with the given value. If replacement is not set and truncate is true – the masked values will be removed. The replacement property has no effect when the signal input is an event.

If replacement is not set and truncate is false (default behavior), the output signal is untouched, except that the event cycles are annotated on the signal.

title: eventMask step

title: eventMask > keep

description:
An index or an array of indices of events in each cycle to keep. This allows you to keep only a subset of event instances in each cycle.

Negative numbers can be used to count from the end of the cycle, e.g. -1 is the last event in the cycle.

Note: This only applies to event inputs.

title: eventMask > replacement

description:
Replacement value to use for masked values. If not set, masked values will be removed from the output signal.

The replacement property has no effect when the signal input is an event.

title: eventMask > truncate

description:
Whether or not the signal should be truncated, i.e., if values that were not within an "event pair" should be removed or not.

This will only apply if replacement does not have a value.

title: Step: eventTime

description:
This step takes an event input and converts each frame value to a time value (in seconds).

The time is calculated using the frame rate from the signal.

title: eventTime step

description:
This step takes an event input and converts each frame value to a time value (in seconds).

The time is calculated using the frame rate from the signal.

title: Step: refineEvent

description:
This step allows you to easily pick out frames from an event only when they appear in a specific sequence of other events.

The main input of this step is the event you want to select frames from.

The required option sequence defines a sequence of events to happen in order. This option requires at least one instance of the main input event (otherwise, no event would be able to be picked from the sequence).

Multiple instances of the main input event can be supplied to the sequence to enable more complex patterns of events.

The optional option exclude defines events that cannot occur in a sequence. If it does, the sequence is invalidated, meaning no events will be picked from this sequence.

The exclude option cannot contain any signals defined in the sequence option.

The optional option cyclic defines whether or not the sequence should be treated as cyclic, i.e., if the sequence starts and ends with the same events, those events are included in the next "match-finding" iteration of the sequence. This is useful for refining event cycles where the end event is the start event of the next cycle.

The cyclic option is true by default and has to be explicitly set to false to disable.

title: refineEvent step

title: refineEvent > sequence

description: A sequence of events. This must include at least one instance of the main input event.

title: refineEvent > exclude

description: Event(s) that will invalidate an event sequence if found within it.

title: refineEvent > cyclic

description: Whether or not to treat sequences as cyclic (true as default).

title: Step: peakFinder

description:
Find peaks inside a signal based on peak properties.

At first, it will detect any peak-like features in the signal. If any of the options distance, height, prominence, or width is defined, it will use those properties to filter out peaks that match the criteria.

As a last step, if the sequence option is used, it will match the peaks against a sequence to return a subset of the peaks.

As a general rule, the peakFinder step is sensitive to noise in the data, so if noise is expected, first run the data through a low-pass filter.

Based on the SciPy find_peaks function.

title: peakFinder step

title: peakFinder > distance

description:
Required minimal horizontal distance (>= 1) in samples between neighbouring peaks.

Smaller peaks are removed first until the condition is fulfilled for all remaining peaks.

title: peakFinder > height

description: Required height of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required height.

title: peakFinder > prominence

description: Required prominence of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required prominence.

title: peakFinder > relHeight

description:
Used for calculation of the peaks width, thus it is only used if width is given.

Chooses the relative height at which the peak width is measured as a percentage of its prominence. 1.0 calculates the width of the peak at its lowest contour line while 0.5 evaluates at half the prominence height. Must be at least 0.

title: peakFinder > sequence

description:
Allows to classify peaks using a pattern and select peaks from the pattern to use as the output.

See below for further information.

title: peakFinder > sequence > ranges

description:
Classification of the peak heights. This option expects a string consisting of 1-character labels separated by a boundary value.

The boundary values represent a percentage between 0 – 100 which defined the end of the previous label's range and the beginning of the next label's range.

The entire range 0 – 100 represents the difference between the lowest peak and the highest peak. All peaks will be somewhere in this range, and the ranges option allows you to customize how the peaks are labelled.

The default ranges value is: L 50 H. This labels the peaks that end up in the bottom 50% of the peak heights as L, and the remaining top 50% as H.

The syntax, L 50 H, is equivalent to writing 0 L 50 H 100.

The outer boundaries 0 and 100 is assumed though and are not required.

If you would like to classify the peaks into three groups, the bottom 25% as L, the top 25% and H, and anything in between as M, you can supply the following string: L 25 M 75 H.

The labels used should each be 1 character long, but can be whatever you want as long as it corresponds to the pattern used in the pattern option.

title: peakFinder > sequence > pattern

description:
A pattern describing a sequence of classified peak heights using the labels defined in the ranges option.

If you have supplied the ranges string L 50 H, and you want to find the following sequence of peaks: "a low peak followed by a low peak followed by a high peak, you can define the pattern as LLH.

Each matching pattern sequence is stored and the pattern indices in keep determines which of the peaks that are returned.

title: peakFinder > sequence > keep

description:
An array of indices from the pattern labels to keep in the output. The index is zero-based, i.e., the first item in the sequence pattern is 0, the last in the sequence is the (length of the pattern) - 1.

If the pattern was defined as LLH and we wanted to keep only the first (low) peak in each matching sequence, we would set keep to [0].

Conversely if we wanted to keep the last (high) peak in each sequence, the keep should be [2].

To keep both the first and last peaks in the sequence, the keep option should be set to [0, 2].

Peaks in the sequence pattern not indexed by keep will be ignored in the output.

title: peakFinder > width

description:
Required width of peaks in samples. Either a number or a
2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required width.

title: peakFinder > window

description:
Used for calculation of the peaks prominences, thus it is only used if one of the arguments prominence or width is given.

A window length in samples that optionally limits the evaluated area for each peak to a subset of x. The peak is always placed in the middle of the window therefore the given length is rounded up to the next odd integer. This parameter can speed up the calculation.

title: Step: threshold

description:
This step will register an event for every frame where the signal passes the specified threshold value.

By default, an event is registered when the signal crosses the threshold in either an ascending or descending direction.

By configuring the direction option, you can specify a certain direction that will trigger the event; up (ascending) or down (descending).

title: threshold step

title: threshold > value

description: The threshold value to use.

title: threshold > direction

description: The direction of crossing the threshold to record.

title: Step: concatenate

description: The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.

title: concatenate step

description: The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.

title: Step: vector

description:
The vector step takes one or three inputs and outputs a vector sequence signal.

If given three numeric or 1-dimensional series inputs, each input will be assigned to the x, y, and z components, respectively.

Alternatively, if only one input is given and it contains at least three components, the first three components will be used to construct the vector sequence.

If the inputs have different lengths, the output signal will be the length of the longest input and shorter inputs will be padded with NaN values.

title: vector step

title: Measurement filtering

description:
When importing a signal or defining an output node, you can specify a measurement from which the signal should be imported – or for which measurement an output node should run.

You can filter measurements by name and by field values and you can use wildcard characters `*` to formulate patterns to match partial values. The matching of values is case-insensitive.

When using a measurement filter, a list of matching measurements is created. By specifying the `index` option, you can define which of the matching measurements should apply.

title: Name filter

description: Target a measurement by name

title: Index filter

description: Out of a number of matching measurements, pick the nth match. Either a 1-based index, or the values `first` or `last` to select the first or last match, respectively.

title: Field filter

description: Target a measurement by a field value.

title: Field to match against

title: Output set

description:
Used to specify which _set_ the exported parameter will use. In most cases, this will be either `left` or `right`.

If not set, the JSON output will use set: null.

title: Origin

description: Sets the origin of a custom coordinate system.

title: Primary axis

description:
Sets the primary axis of a custom coordinate system. The primary axis of the custom coordinate system will always be a unit vector with the same direction as this vector.

If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the primary axis.

title: Secondary axis

description:
Sets the secondary axis of a custom coordinate system. The actual secondary axis of the custom coordinate system might differ from the vector specified, since the secondary axis must be a unit vector perpendicular to the primary axis.

If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the secondary axis.

title: Order

description:
Defines what axis the primary and secondary axis corresponds to. The first letter defines the name of the primary axis, and the second letter defines the name of the secondary axis.

Possible values:
xy - Primary axis: x, secondary axis: y
yx - Primary axis: y, secondary axis: x
xz - Primary axis: x, secondary axis: z
yz - Primary axis: y, secondary axis: z
zy - Primary axis: z, secondary axis: y

title: Align with segment

description:
Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space.

The rotation is based on the average orientation of the segment during a measurement.

title: Segment to align to

title: Parameter node

export

title: export (global option)

description:
If this option is set, the result of this step will be exposed on the global scope, as well as being exported to the resulting JSON file.

The value of this option will be the name of the exported data and can be used to load the resulting data in other steps.

output

title: output (global option)

description:
If this option is set, the result of this step will be exposed on the local scope.

The value of this option will be the name of the output data and can be used to load the resulting data in other steps within the same output node.

You can also use the short-form "arrow syntax" to define an output.

set

title: set (global option)

description:
Used to specify which set the exported parameter will use. In most cases, this will be either left or right.

This option is only used in two cases; where there is also an export option set, or on the last step in a list. In the latter case, the step's set is used only if there's no set defined on the parent output node.

If this option is not set, the JSON output will use set: null.

space

title: space (global option)

description:
This option lets you reference a space where you want the input data for the step to be translated into.

All named inputs will automatically be converted.

NOTE: This is not yet implemented for segments.

project

title: project (Angle category option)

description:
If set to a string, the angle will be calculated in two dimensions on the specified coordinate plane by ignoring the component of the input signals which is not part of the plane.

Using a PlaneSequence, projects the input vectors on the provided plane.

Note: _The projection is only applied for vector-based angles and is ignored when calculating joint angles._

rotationOrder

title: rotationOrder (Angle category option)

description:
The rotation order to use for calculating the Euler angle. Possible rotation orders are:

Cardan sequence: XYZ YZX ZXY XZY YXZ ZYX

Euler sequence: XYX XZX YXY YZY ZXZ ZYZ

unwrap

title: unwrap (Angle category option)

description:
When set to true, an event, or a numeric value, the unwrap option shifts the angle phases in order to achieve a continuous curve, i.e., it tries to detect when an angle crosses over its available range (-PI to PI for radians, -180 to 180 degrees).

This allows for tracking angles on movements that goes outside of the typical angle range.

To do this, it looks for jumps between consecutive angles. If the jump is greater than a threshold of half the range (PI for radians, 180 for degrees), the angle is shifted by adding multiples of of the range until the jump no longer crosses the threshold.

The unwrap algorithm is run over all available components.

If set to true or 0, the algorithm aligns the unwrap to the start of the sequence. I.e., it assumes the first frame is correct in being within the original range and the following angles are moved to follow suit.

If set to an Event or a Number, the algorithm will assume that the corresponding frame is correct in being within the original range. All other angles will be shifted to follow suit. This enables tracking a rotational movement where the angle for a specific event is intended to be within the standard range (-PI to PI for radians, -180 to 180 degrees).

IF a supplied event has more than one instance, the first instance is used.

Note: _The unwrap algorithm is sensitive to noise, which may introduce unexpected artifacts. Please consider filtering the signal(s) before calculating its angle using unwrap._

useCycles

title: useCycles (Aggregation category option)

description:
If the signal has cycles defined, the aggregation will be run separately over each signal, and a list of values are returned, one for each cycle.

To avoid this behaviour, set useCycles to false.

For information on how to set event cycles on a signal, see the eventMask step.

frameSequenceOrder

title: frameSequenceOrder (Arithmetic category option)

description:
If set to any value but none, the input signals will pass through a function which returns a list of signals where each value is from a frame greater than or equal to the frame of the corresponding value from the preceding Signal.

If set to forward, it will start from the first value of the first (leftmost) input signal (operand) and the algorithm will look at subsequent operands (to the right) one "row" at a time.

Conversely, if set to reverse, the event sequencing uses the reverse order of operands and goes from right to left.

If a full "row" of values could not be matched, it is not included in the result, i.e., all operands will be of the same length.

This is useful, for example, when calculating the distance between two signals at a certain event.

The function will only apply if all input signals have applied a Frames filter, otherwise the signals are left untouched.

Example

subtract: [LeftFoot.y@LFS, RightFoot.y@RFS]            frameSequenceOrder: reverse

_Creates an event sequence from the inputs, starting from the second operand (RFS event) and creates event pairs RFS -> LFS out of the values. It then subtracts each frame from the RightFoot from the corresponding LeftFoot frame._

_If frameSequenceOrder had been set to forward, it would have created pairs going from LFS -> RFS instead._

_Using the frameSequenceOrder option ensures that the operands starts with the intended event and that both operands have the same length._


$xsd-type: SignRequestType

type: object

type: array

type: string

$xsd-type: InputDocumentsType

$xsd-type: DocumentType

$xsd-type: AttachmentReferenceType

$ref: #/definitions/dsb-DigestInfoType

$xsd-type: DigestInfoType

required: alg val

$xsd-type: TransformedDataType

$ref: #/definitions/dsigrw-TransformsType

type: integer

$xsd-type: TransformsType

$ref: #/definitions/dsigrw-TransformType

$xsd-type: TransformType

$ref: #/definitions/dsb-NsPrefixMappingType

$xsd-type: NsPrefixMappingType

required: uri pre

$xsd-type: DocumentHashType

$xsd-type: OptionalInputsSignType

$ref: #/definitions/dsb-AnyType

type: boolean

default: false

$xsd-type: AnyType

$xsd-type: ClaimedIdentityType

$xsd-type: NameIDType


lazydocker.json

enum: black red green yellow blue magenta cyan white bold default reverse underline strikethrough

description:
Settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: gui

description:
UI settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: scroll height

description:
A scroll height
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: language

description:
A language
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

enum: auto en pl nl de tr

default: auto

title: theme

description:
Theme settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: active border color

description:
An active border color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

$ref: #/definitions/color

title: inactive border color

description:
An inactive border color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: selected line background color

description:
A selected line background color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: options text color

description:
An option text color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: return immediately

description:
Whether to return immediately
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: wrap main panel

description:
Whether to wrap main panel
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: side panel width

description:
A side panel ratio of screen's width
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

type: number

title: show bottom line

description:
Whether to show bottom line
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: expand focused side panel

description:
Whether to expand focused side panel
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: screen mode

description:
A screen mode
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

enum: normal half fullscreen

default: normal

title: container status health style

description:
A style of container status and it's health display
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

enum: long short icon

default: long

title: logs

description:
Log settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: timestamps

description:
Whether to show timestamps
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: since

description:
A start time
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: tail

description:
A last line count
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: command templates

description:
Command templates
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: docker compose

description:
A docker compose command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: docker-compose

title: restart service

description:
A restart service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} restart {{ .Service.Name }}

title: up

description:
An up command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} up -d

title: down

description:
A down command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} down

title: down with volumes

description:
A down with volumes command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} down --volumes

title: up service

description:
An up service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} up -d {{ .Service.Name }}

title: start service

description:
A start service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} start {{ .Service.Name }}

title: stop service

description:
A stop service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} stop {{ .Service.Name }}

title: service logs

description:
A service logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs --since=60m --follow {{ .Service.Name }}

title: view service logs

description:
A view service logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs --follow {{ .Service.Name }}

title: rebuild service

description:
A rebuild service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} up -d --build {{ .Service.Name }}

title: recreate service

description:
A recreate service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} up -d --force-recreate {{ .Service.Name }}

title: all logs

description:
An all logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs --tail=300 --follow

title: view al logs

description:
A view al logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs

title: docker compose config

description:
A docker compose config command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} config

title: check docker compose config

description:
A check docker compose config command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} config --quiet

title: service top

description:
A service top command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} top {{ .Service.Name }}

title: os

description:
OS settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: open command

description:
An open command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: open {{filename}}

title: open link command

description:
An open link command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: open {{link}}

title: stats

description:
Statistic settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: graphs

description:
Graph settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: caption

description:
A caption
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: stat path

description:
A path
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: color

description:
A color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: custom commands

description:
Custom commands
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: containers

description:
Container settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: name

description:
A name
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: attach

description:
Whether to attach
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: command

description:
A command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

examples: docker exec -it {{ .Container.ID }} bash

title: service names

description:
Service names
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

description:
A service name
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: replacements

description:
Replacement settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: replacement group

description:
A replacement group
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

title: replacement

description:
A replacement
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

examples: <dev> <prod>

title: ui settings


band-manifest.json

description: The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

description: The numeric id of the icon layout element based on the predefined layout selected.

description: If set, then must be set to 'true' for this release

required: url style content

description: The URL to be referenced. For resources that require authentication, the URL must be HTTPS.

format: uri

description: Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.

pattern: ^([sS]imple|[fF]eed)$

default: Simple

description: This member specifies how to extract content from the web response.

description: The name of the layout for the page. The layout name should refer to one of the predefined page layouts.

$ref: #/definitions/condition

description: Similar to textBindings, but used to select one of the web tile icons in icons list for each icon in the page. If there are no icon elements on the page, this member may be omitted.

$ref: #/definitions/iconBinding

description: An array of objects corresponding to each page element that contains string content. Each binding object provides the numeric id of the page element based on the predefined layout selected, and the string value that it should contain.

$ref: #/definitions/textBinding

required: conditions elementId

$ref: #/definitions/elementId

description: For this release, this must contain an array with a single 'condition' object whose 'condition' is true, and whose 'icon' member specifies the name of the icon to be used.

description: The name of the icon as specified in the 'icons' node.

required: elementId value

required: condition title

description: The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax '<Operand1> <Operator> <Operand2>' or 'true'.

description: The text to use for the notification title. If longer than 20 characters, it will be truncated.

description: The text to use for the notification body. If longer than 20 characters, it will be truncated.

description: Defines the contract between the web tile developer and the Microsoft Health app. It must be set to 1 for the current release.

description: Defines the name of the web tile.

description: Provides description about the web tile.

description: Indicates the version number of the web tile which will not be shown to users.

description: Indicates the web tile version as shown to users. If not provided, it displays the version.

description: Specifies the author of the web tile.

description: Specifies the organization associated with the web tile.

description: Provides contact info of the web tile author. Used for administrative purposes and analytics by Microsoft Band team.

format: email

description: Specifies the location of the large tile icon.

$ref: #/definitions/icon

description: Specifies the location of the small tile icon. If not provided, the badging functionality is not enabled.

description: Specifies the custom theme colors for the web tile.

description: Specifies the desired data refresh interval, in minutes. Refresh intervals shorter than 15 will not be honored. If not provided, it defaults to 30.

description: Each web tile must refer to one or more web resources. Each resource object describes a web data from which content for the tile will be extracted.

$ref: #/definitions/resource

description: All PNG icons used by the tile within its pages must be provided here.

description: Each tile consists of one or more pages, as described by the objects in this array. Each page object specifies the layout and content of the page.

$ref: #/definitions/page

description: Creates notification that gets delivered when certain conditions are detected in the new web data.

$ref: #/definitions/notification

required: manifestVersion name tileIcon resources pages

title: JSON schema for Microsoft Band manifests


openweather.roadrisk.json

description: API responses from the OpenWeather Road Risk API from https://openweathermap.org/api/road-risk

required: dt coord weather alerts

title: OpenWeather Road Risk API


packer.json

enum: alicloud-ecs amazon-ebs azure-arm azure-chroot cloudstack custom digitalocean docker file googlecompute hcloud hyperone hyperv-iso hyperv-vmcx jdcloud linode lxc lxd ncloud null ocs-chroot oneandone openstack oracle-classic oracle-oci osc-bsu osc-bsusurrogate parallels-iso parallels-pvm profitbricks proxmox qemu scaleway tencentcloud-cvm triton ucloud-uhost vagrant virtualbox-iso virtualbox-ovf virtualbox-vm vmware-iso vmware-vmx vsphere-clone vsphere-iso yandex

const: vagrant

const: virtualbox-iso

enum: shell ansible-local

$ref: #/definitions/provisioner-ansible-local

$ref: #/definitions/provisioner-shell

enum: compress upload

$ref: #/definitions/builder-vagrant

$ref: #/definitions/builder-virtualbox-iso

$ref: #/definitions/provisioner

enum: vagrant compress

$ref: #/definitions/post-processor


chisel-slices.json

description: A slice definition for Ubuntu Chisel tool. For details, see https://github.com/canonical/chisel/tree/main#slice-definitions.

description: The name of the package to use for the slice.

description: The name of the archive to use for the slice. Archives are defined in the chisel.yaml file.

description: Slice definitions for this package.

description: The name of the slice part.

description: The name of the dependency slice part. The slice part is formatted as '<slice_name>_<slice_part>'.

description: A Starlark expression to modify the file contents.

description: Files to include in the slice. Supports glob patterns.

text: Some text

text: FIXME

until: mutate

description: Path description.

description: Make this file or directory if it does not already exist.

description: File permissions to use.

description: Copy this file or directory from this location.

description: The contents of the file.

description: Make a symlink to this file or directory.

description: If true, the file is mutable.

description: Only keep this file until this stage.

$comment: Valid values: 'mutate' and ''. But most editors will not accept an empty string.

description: Only include this file on specific architectures.

title: Canonical Chisel Slice Definition


$ref: #/definitions/ServiceDescriptor

$ref: #/definitions/Require

$ref: #/definitions/Events

required: description requires events

title: ServiceDescriptor

$ref: #/definitions/Consumes

$ref: #/definitions/Produces

required: consumes produces

title: Events

title: Consumes

title: Produces

$ref: #/definitions/Use

required: service uses version

title: Require

enum: internal external integration

enum: REST library

required: api type

title: Use


ansible.json

markdownDescription:
* Includes a file with a list of plays to be executed.
 *  Files with a list of plays can only be included at the top level.
 * You cannot use this action inside a play.

See [import_playbook](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/import_playbook_module.html)

title: Import Playbook

title: Name

$ref: #/$defs/tags

title: Vars

title: When

$ref: #/$defs/full-jinja

title: Become Method

$ref: #/$defs/task

$ref: #/$defs/block

title: Always

$ref: #/$defs/templated-boolean

title: Any Errors Fatal

title: Become

title: Become Exe

title: Become Flags

title: Become User

markdownDescription: Blocks create logical groups of tasks. Blocks also offer ways to handle task errors, similar to exception handling in many programming languages. See [blocks](https://docs.ansible.com/ansible/latest/user_guide/playbooks_blocks.html)

title: Block

title: Check Mode

title: Collections

title: Connection

title: Debugger

title: Delegate Facts

title: Delegate To

title: Diff

$ref: #/$defs/environment

title: Ignore Unreachable

title: Module Defaults

title: Name

$ref: #/$defs/templated-integer

title: Remote User

title: Rescue

title: Run Once

title: Tags

title: Throttle

title: Timeout

title: Vars

title: When

title: Environment

title: Ignore Errors

markdownDescription: Use for protecting sensitive data. See [no_log](https://docs.ansible.com/ansible/latest/reference_appendices/logging.html)

title: no_log

title: Any Errors Fatal

title: Become

title: Become Exe

title: Become Flags

title: Become User

title: Check Mode

title: Collections

title: Connection

title: Debugger

title: Diff

title: Fact Path

title: Force Handlers

title: Gather Facts

title: Gather Subset

title: Gather Timeout

$ref: #/$defs/tasks

title: Hosts

title: Ignore Unreachable

title: Max Fail Percentage

title: Module Defaults

title: Name

title: Order

title: Port

title: Remote User

$ref: #/$defs/play-role

markdownDescription:
Roles let you automatically load related vars, files, tasks, handlers, and other Ansible artifacts based on a known file structure. After you group your content in roles, you can easily reuse them and share them with other users.
 See [roles](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#roles)

title: Roles

title: Run Once

$ref: #/$defs/templated-integer-or-percent

markdownDescription: Integer, percentage or list of those. See [Setting the batch size with serial](https://docs.ansible.com/ansible/latest/user_guide/playbooks_strategies.html#setting-the-batch-size-with-serial)

title: Batch size

title: Strategy

title: Tags

title: Throttle

title: Timeout

title: Remote User

title: Vars

title: Vars Files

title: vars_prompt

title: When

title: play

title: Any Errors Fatal

title: Become

title: Become Exe

title: Become Flags

title: Become User

title: Check Mode

title: Collections

title: Connection

title: Debugger

title: Delegate To

title: Diff

title: Ignore Unreachable

title: Module Defaults

title: Name

title: Port

title: Remote User

title: Role

title: Run Once

title: Tags

title: Throttle

title: Timeout

title: Vars

title: When

title: play-role

title: Ansible Playbook

title: Tags

title: Action

title: Any Errors Fatal

title: Args

title: Async

title: Become

title: Become Exe

title: Become Flags

title: Become User

title: Changed When

title: Check Mode

title: Collections

title: Connection

title: Debugger

title: Delay

title: Delegate Facts

title: Delegate To

title: Diff

title: Failed When

title: Ignore Unreachable

markdownDescription: Applies only to handlers. See [listen](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html)

title: Listen

title: Local Action

title: Loop

title: Loop Control

title: Module Defaults

title: Name

title: Notify

title: Poll

title: Port

title: Register

title: Remote User

title: Retries

title: Run Once

title: Tags

title: Throttle

title: Timeout

title: Until

title: Vars

title: When

title: With Dict

title: With Fileglob

title: With Filetree

title: With First Found

title: With Indexed Items

title: With Ini

title: With Inventory Hostnames

title: With Items

title: With Lines

title: With Random Choice

title: With Sequence

title: With Subelements

title: With Together

title: task

title: Ansible Tasks Schema

title: Confirm

title: Default

title: Encrypt

title: Name

title: Private

title: Prompt

title: Salt Size

title: Unsafe

title: Ansible Schemas Bundle 22.4


dart-build.json

$ref: #/definitions/buildConfig

$ref: #/definitions/buildTarget

$ref: #/definitions/targetKey

$ref: #/definitions/builderDefinition

$ref: #/definitions/builderKey

$ref: #/definitions/globalBuilderOptions

$ref: #/definitions/targetBuilderConfig

$ref: #/definitions/inputSet

$ref: #/definitions/autoApply

$ref: #/definitions/runsBefore

$ref: #/definitions/buildTo

default: cache

title: The name of the dart_library target that contains the import

deprecationMessage: May be null or unreliable and should not be used.

$comment: Use List<String> directly, inferred to mean include.

$ref: #/definitions/builderOptions

title: Options to apply to a builder

description: An arbitrary Map<String, dynamic> of configuration options exposed by the individual builders. See the documentation for the builder you are configuring for guidance.

description: On which packages the builder is applied by default

description: Whether the outputs should be stored in a hidden cache or in the source directory.

enum: cache source

title: An identifier for a target

description: A target key has two parts, a package and a name. They are separated by a colon.

title: An identifier for a builder

description: To construct a key, you join the package name and the builder name with a colon.

description: Configuration for Dart's build system

title: build.yaml files


drupal-libraries.json

title: The library version

title: The library repository URL

title: The human-readable name of the license

title: The URL of the license file/information for the version of the library used

title: A boolean for whether this library is GPL compatible

title: A boolean for whether the script must be included in the header

title: Settings that needs to be attached to drupalSettings object in JavaScript

title: List of JavaScript files to load

$ref: #/definitions/file

title: List of CSS files to load

$ref: #/definitions/cssFiles

title: List libraries that should be loaded along with this library

title: Optional attributes

title: Load asset conditionally based on browser

title: Whether the asset is already minified

title: The source of the asset

title: Whether the assets should be aggregated

title: The order relative to other assets

title: The SMACSS group in which the asset is placed

title: Media type

enum: all screen print speech

title: JSON schema for Drupal libraries file


server.schema.json

title: Tray Option

description: An object that represents a single tray menu item

title: Label

description: Text of menu item

title: Action

description: Action to perform when user clicks this menu item. 'openfilesystem', 'openbrowser', or 'stopserver'

title: URL

description: Url to open for 'openbrowser' action

title: Disabled

description: Turn menu item grey and nothing happens when clicking on it

title: Image

description: Path to PNG image to display on menu item next to the label

title: Hotkey

description: Keyboard shortcut to choose this menu item

title: Path

description: Filesystem path to open for 'openfilesystem' action

title: Items

description: Nested menu items

$ref: #/definitions/trayOptionsItem

title: CommandBox Server

description: Configuration file for a CommandBox server

title: Name

description: The name of the server

title: Open Browser

description: Controls whether browser opens by default when starting server

title: Open Browser URL

description: Override the URL to open when starting the server

title: Server start timeout

description: The length of time in seconds to wait for the server to start

title: Stop Socket

description: The port the server listens on to receive a stop command

title: Debug

description: Enable debug level logging for server

title: Trace

description: Enable trace level logging for server

title: Console

description: Start the server in console mode instead of in the background

title: Tray Enable

description: Control whether the server has an associated icon in the system tray

title: Tray Icon

description: Path to the server's tray icon

title: Tray Options

description: An array of custom menu items to be added to the server's tray menu

title: JVM

description: JVM Options

title: Max Heap Size

description: The max heap size of the server

type: number string

title: Min Heap Size

description: The starting heap size for the server

title: JVM Arguments

description: Ad-hoc JVM args for the server such as -X:name

title: Java Home Path

description: Path to custom JRE. Default is the one that the CommandBox CLI is using

title: Java Version

description: A Java installation ID. In its entirety, it has the form <version>_<type>_<arch>_<os>_<jvm-implementation>_<release>

title: Web

description: Web Server Options

title: Host

description: The default host name of the server

title: Webroot

description: Webroot directory

title: Directory Browsing

description: Enables file listing for directories with no welcome file

title: Access Log Enable

description: Enable web server access log

title: GZIP Enable

description: Enable GZip compression in HTTP responses

title: Welcome Files

description: A comma-delimited list of files that you would like CommandBox to look for when a user hits a directory

title: Aliases

description: Web aliases for the web server, similar to virtual directories

title: Alias

description: The key is the web-accessible virtual path and the value is the relative or absolute path to the folder the alias points to

title: Error Pages

description: The error pages that CommandBox servers return. You can have a setting for each status code including a default error page to be used if no other setting applies

title: Default

description: Path to default error page

title: Error Page

description: The key is the status code integer and the value is a relative (to the web root) path to be loaded for that status code

title: HTTP Settings

description: Configure the HTTP listener on the server

title: Enable

description: Enable HTTP for this serer

title: Port

description: HTTP port to use

title: SSL

description: Configure the HTTPS listener on the server

title: Enable

description: Enable HTTPS for this server

title: Port

description: HTTPS port to use

title: Cert File

description: Path to SSL cert file

title: Key File

description: Path to SSL key file

title: Key Pass

description: Password for SSL key file

title: AJP

description: Configure the AJP listener on the server

title: Enable

description: Enable AJP for this server

title: Port

description: AJP port to use

title: Rewrites

description: Configure URL Rewrites

title: Enable

description: Enable URL Rewrites on this server

title: Log Enable

description: Enable Rewrite log file

title: Config

description: Path to xml config file or .htaccess

title: Tuckey Status Path

description: URL path to visit Tuckey status page like '/tuckey-status'

default: /tuckey-status

title: Config Reload Seconds

description: Number of seconds to check rewrite config file for changes

title: Configure basic authentication

title: Enable

description: Enable basic auth for this server

title: Users

description: Users who can authenticate to basic auth

title: User

description: The key is the user name and the value is the password.

title: Application

description: Application Server Options

title: Log Directory

description: The folder path where the servlet out, rewrite, and access log are written to

title: Jar lib Directories

description: A comma-delimited list of directories from which CommandBox will load JARs

title: Web Context Directory

description: Directory for Lucee/Railo web context

title: Server Context Directory

description: Directory for Lucee/Railo server context

title: Web XML

description: Path to web.xml file

title: WAR Path

description: Path to a local WAR archive or exploded WAR folder.  Mutually exclusive with cfengine.

title: CFML Engine

description: An Endpoint ID that resolves to a CF engine such as 'adobe' or 'lucee'. Include version as 'adobe@2016'

title: REST Mappings

description: Comma delimited list of paths to map to the CF engine's REST servlet such as '/rest/*,/api/*'

title: Server Home Directory

description: Path to folder where the server WAR will be expanded

title: Session Cookie Secure

description: Enable secure session cookies

title: Session Cookie HttpOnly

description: Enable HTTP-only session cookies

title: Configure RunWar

description: These settings apply to the underlying Runwar library that starts servers

title: Arguments

description: Ad-hoc options for the underlying Runwar library


trivia.schema.json

title: Red-DiscordBot Trivia List file

description: Author of the Trivia list.

description: The configuration for a trivia session.

description: Whether or not the bot gains points during the session.

description: The maximum number of seconds permitted to answer a question, must be a positive number greater than or equal to 4.0.

description: Number of points required in order to win the trivia, must be a positive integer.

description: The payout multiplier, must be a positive number or zero.

description: Whether or not to reveal the answer when the question times out.

description: Number of seconds that need to pass until trivia stops due to no response, must be a positive number greater than 0.0.

description: Whether to hide the answers in spoilers when revealing the question's answers.


djlint.json

profile: html

description: JSON schema fcor djLint's configuration file

$ref: #/definitions/css-beautify

$ref: #/definitions/js-beautify

examples: {filename}:{line}: {code} {message} {match}

enum: html django jinja nunjucks handlebars golang angular

title: djlint schema


drupal-migration.json

title: The migration ID (machine name)

title: The human-readable label for the migration

title: Whether the migration is auditable

title: List of tags, used by the plugin manager for filtering

title: Deriver class

title: The source plugin configuration

title: Source plugin ID

title: The configuration describing the process plugins

title: The destination plugin configuration

title: Destination plugin ID

title: Migrations to run before this migration

title: List of migration IDs that must be run before this migration

title: List of migration IDs that, if they exist, must be run before

title: The migration's dependencies

title: List of plugin providers

title: Class for migration implementation

title: JSON schema for Drupal migration files


host.json

description: Configuration settings for the function result aggregator.

description: The maximum batch size for aggregations. If this value is reached before the 'flushTimeout', all values will be flushed.

description: The aggregation duration. The aggregator will flush periodically based on this value.

description: The list of functions the host should load.

description: Value indicating the timeout duration for all functions.

description: Set of shared code directories that should be monitored for changes to ensure that when code in these directories is changed, it is picked up by your functions

description: Configuration settings for Singleton lock behavior.

description: The period that function level locks are taken for (they will auto renew).

description: The period that listener locks are taken for.

description: The time interval used for listener lock recovery if a listener lock couldn't be acquired on startup.

description: The maximum amount of time the runtime will try to acquire a lock.

description: The interval between lock acquisition attempts.

description: Configuration settings for the Functions host health monitor

description: Specifies whether the feature is enabled.

description: The time interval between the periodic background health checks

description: A sliding time window used in conjunction with the healthCheckThreshold setting.

description: Maximum number of times the health check can fail before a host recycle is initiated.

description: The threshold at which a performance counter will be considered unhealthy.

description: Configuration settings for 'http' triggers.

description: Defines the default route prefix that applies to all routes. Use an empty string to remove the prefix.

default: api

description: Defines the the maximum number of http functions that will execute in parallel.

description: Defines the maximum number of outstanding requests that will be held at any given time.

description: Indicates whether dynamic host counter checks should be enabled.

description: Configuration settings for Strict-Transport-Security

description: Indicates whether the hsts configuration should be applied

description: Defines the list of host names that will not add the HSTS header.

description: Indicates whether the includeSubDomain parameter of the Strict-Transport-Security header should be enabled.

description: Defines the max-age parameter of the Strict-Transport-Security header.

description: Indicates whether the preload parameter of the Strict-Transport-Security header should be enabled.

description: Allows you to set custom headers in the HTTP response, ex. X-Content-Type-Options.

description: Configuration settings for 'queue' triggers.

description: The maximum interval in milliseconds between queue polls.

description: The number of queue messages to retrieve and process in parallel (per job function).

description: The number of times to try processing a message before moving it to the poison queue

description: The threshold at which a new batch of messages will be fetched. The default is batchSize/2.

description: The visibility timeout that will be applied to messages that fail processing.

description: The maximum interval between queue polls. Minimum is 00:00:00.100 (100 ms).

description: The time interval between retries when processing of a message fails.

description: The number of queue messages that the Functions runtime retrieves simultaneously and processes in parallel. When the number being processed gets down to the `newBatchThreshold`, the runtime gets another batch and starts processing those messages. So the maximum number of concurrent messages being processed per function is `batchSize` plus `newBatchThreshold`. This limit applies separately to each queue-triggered function.

description: This setting is only available in extension version 5.0.0 and higher. It represents the encoding format for messages.

description: Configuration settings for 'orchestration'/'activity' triggers.

description: Alternate task hub names can be used to isolate multiple Durable Functions applications from each other, even if they're using the same storage backend.

default: DurableFunctionsHub

description: The number of messages to pull from the control queue at a time.

description: The number of control queue messages that can be buffered in memory at a time, at which point the dispatcher will wait before dequeuing any additional messages.

description: The visibility timeout of dequeued control queue messages.

description: The maximum control and work-item queue polling interval in the hh:mm:ss format. Higher values can result in higher message processing latencies. Lower values can result in higher storage costs because of increased storage transactions.

description: The partition count for the control queue. May be a positive integer between 1 and 16.

description: The name of a connection string to use for the History and Instances tables. If not specified, the azureStorageConnectionStringName connection is used.

description: The prefix to use for the History and Instances tables when trackingStoreConnectionStringName is specified. If not set, the default prefix value will be DurableTask. If trackingStoreConnectionStringName is not specified, then the History and Instances tables will use the hubName value as their prefix, and any setting for trackingStoreNamePrefix will be ignored.

description: When set to false, uses a partition management algorithm that reduces the possibility of duplicate function execution when scaling out.

description: The visibility timeout of dequeued work item queue messages.

description: A value indicating whether to trace the inputs and outputs of function calls. The default behavior when tracing function execution events is to include the number of bytes in the serialized inputs and outputs for function calls. This behavior provides minimal information about what the inputs and outputs look like without bloating the logs or inadvertently exposing sensitive information. Setting this property to true causes the default function logging to log the entire contents of function inputs and outputs.

description: A value indicating whether to write orchestration replay events to Application Insights.

description: The URL of an Azure Event Grid custom topic endpoint. When this property is set, orchestration life-cycle notification events are published to this endpoint. This property supports App Settings resolution.

description: The name of the app setting containing the key used for authenticating with the Azure Event Grid custom topic at EventGridTopicEndpoint.

description: The number of times to retry if publishing to the Event Grid Topic fails.

description: The Event Grid publishes retry interval in the hh:mm:ss format.

description: A list of event types to publish to Event Grid. If not specified, all event types will be published.

enum: Started Pending Completed Failed Terminated

description: The maximum number of activity functions that can be processed concurrently on a single host instance.

description: The maximum number of orchestrator functions that can be processed concurrently on a single host instance.

description: When set to true, apps will require acquiring an app-level blob lease before processing task hub messages.

description: Enable gracefully shutting down to reduce the chance of host shutdowns failing in-process function executions.

description: The maximum number of entity operations that are processed as a batch. If set to 1, batching is disabled, and each operation message is processed by a separate function invocation.

description: Configuration settings for Azure Cosmos DB bindings and triggers.

description: ConnectionMode to be used on the DocumentClients.

enum: Gateway Direct

default: Gateway

description: Protocol to be used on the DocumentClients.

enum: Https Tcp

default: Https

description: Lease prefix to use across all functions in an app.

$ref: #/definitions/aggregator

description: Configuration settings for Application Insights logging.

description: Configuration settings for Application Insights client-side adaptive sampling.

description: If true, client-side adaptive sampling is enabled.

description: The target rate that the adaptive algorithm aims for on each instance

$ref: #/definitions/functions

$ref: #/definitions/functionTimeout

$ref: #/definitions/healthMonitor

description: The unique ID for this job host. Can be a lower case GUID with dashes removed

description: Configuration settings for logging.

description: The default level for logging. If a category level is not specified, this value is used.

enum: Critical Debug Error Information None Trace Warning

default: Information

description: Log levels for specific categories.

$ref: #/definitions/singleton

$ref: #/definitions/watchDirectories

description: Configuration settings for logging/tracing behavior.

description: The tracing level used for console logging.

enum: off error warning info verbose

description: Value determining what level of file logging is enabled.

description: Configuration settings for 'serviceBus' triggers.

description: The maximum number of concurrent calls to the callback the message pump should initiate.

description: The default PrefetchCount that will be used by the underlying MessageReceiver.

description: The maximum duration within which the Service Bus message lock will be renewed automatically.

description: Specifies whether messages should be automatically completed after successful processing.

description: Configuration settings for 'eventHub' triggers.

description: The maximum event count received per receive loop.

description: The default PrefetchCount that will be used by the underlying EventProcessorHost.

description: The number of batches to process before creating an EventHub cursor checkpoint

description: Configuration settings for extension bundle

description: The id of the extension bundle

description: The version of the extension bundle.

description: Configuration settings for Language Workers.

description: Specifies full path of the directory for language workers

description: Configuration settings for logging.

description: Log levels for specific categories.

description: The interval at which the current rate of telemetry is reevaluated.

description: The initial sampling percentage applied at the start of the sampling process to dynamically vary the percentage.

description: When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to raise sampling percentage again to capture more data.

description: When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to lower sampling percentage again to capture less data.

description: As sampling percentage varies, this property determines the minimum allowed sampling percentage.

description: As sampling percentage varies, this property determines the maximum allowed sampling percentage.

description: In the calculation of the moving average, the weight assigned to the most recent value. Use a value equal to or less than 1. Smaller values make the algorithm less reactive to sudden changes.

description: A semi-colon delimited list of types excluded from sampling. Recognized: Dependency, Event, Exception, PageView, Request, Trace.

description: A semi-colon delimited list of types that you want to be sampled. Recognized: Dependency, Event, Exception, PageView, Request, and Trace.

description: Enables live metrics collection.

description: Enables live metrics filters.

description: Enables dependency tracking

description: Enables Kudu performance counters collection.

description: Enables or disables extended HTTP request information for HTTP triggers.

description: Enables or disables support of W3C distributed tracing protocol (and turns on legacy correlation schema). Enabled by default if enableHttpTriggerExtendedInfoCollection is true. If enableHttpTriggerExtendedInfoCollection is false, this flag applies to outgoing requests only, not incoming requests

description: Enables or disables injection of multi-component correlation headers into responses. Enabling injection allows Application Insights to construct an Application Map to when several instrumentation keys are used.

description: The endpoint used to connect to the Application Insights Snapshot Debugger service.

description: The weight given to the current process memory size when checking if there's enough memory to take a snapshot.

description: The limit on the number of failed requests to request snapshots before the telemetry processor is disabled.

description: Enables or disables tracking of exceptions that aren't tracked by Application Insights telemetry.

description: Enables or disables snapshot collection.

description: Enables or disables snapshot collection is enabled in developer mode.

description: Enables or disables snapshot creation even if the Application Insights Profiler is collecting a detailed profiling session.

description: Enables or disables filtering of exceptions.

description: Determines whether to run the SnapshotUploader process at below normal priority.

description: The maximum number of problems that we can track at any time.

description: The maximum number of snapshots collected for a single problem.

description: How often to reset the problem counters in a range from one minute to seven days.

description: Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger

description: How often we reconnect to the Snapshot Debugger endpoint. Allowable range is one minute to one day.

description: Specifies the folder to use for shadow copying binaries. If not set, the folders specified by the following environment variables are tried in order: Fabric_Folder_App_Temp, LOCALAPPDATA, APPDATA, TEMP.

description: If true, only one instance of SnapshotUploader will collect and upload snapshots for multiple apps that share the InstrumentationKey. If set to false, the SnapshotUploader will be unique for each (ProcessName, InstrumentationKey) tuple.

description: Determines whether or not to process snapshots in a low IO priority thread.

description: The maximum number of snapshots allowed in one day (24 hours). This limit is also enforced on the Application Insights service side.

description: The maximum number of snapshots allowed in 10 minutes. Although there is no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application.

description: Specifies the folder to write minidumps and uploader log files. If not set, then %TEMP%\Dumps is used.

description: How many times Application Insights needs to see an exception before it asks for snapshots.

description: Overrides the proxy server used in the Snapshot Uploader process. You may need to use this setting if your application connects to the internet via a proxy server. The Snapshot Collector runs within your application's process and will use the same proxy settings.

description: Managed dependency is a feature that is currently only supported with PowerShell based functions. It enables dependencies to be automatically managed by the service.

description: If true, the requirements.psd1 file is processed

description: Retry policy of function execution failures at the app level. Retry policy applies to all the functions in the function app.

description: Retry strategy to use for retrying function executions

description: The maximum number of retries allowed per function execution. -1 means to retry indefinitely.

description: Value indicating the delayInterval for function execution retries when using FixedDelay strategy.

description: Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.

description: Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.

description: Configuration settings for Custom Handler.

description: Configuration settings for Custom Handler process

description: Name or path to the Custom Handler process

description: WorkingDirectory to be used by the Custom Handler process. If not set, defaults to function app root folder.

description: Arguments to be passed to the Custom Handler process. Can use environment variables following pattern %envVarName%

description: Forward HttpTrigger request to the custom handler

description: An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files are changed, the updates are picked up by your functions

description: The version of the Azure Functions host.json schema. This is NOT the version of the Azure Functions host.

description: The sender's email address across all functions.

description: The options that will be used for the message handler registered with the MessageReceiver.

description: Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion.

description: The maximum number of sessions that can be handled concurrently per scaled instance.

description: The maximum number of messages sent to the function when triggered.

description: A time span value expressed in hh:mm:ss.

description: Whether the trigger should automatically call complete after processing, or if the function code will manually call complete.

description: The target number of unprocessed events per worker for Event Hub-triggered functions. This is used in target-based scaling to override the default scaling threshold inferred from maxEventBatchSize.

description: The maximum number of events that will be included in a batch for a single invocation.

description: The number of batches to process before creating a checkpoint for the Event Hub.

description: The number of events that will be eagerly requested from Event Hubs and held in a local cache to allow reads to avoid waiting on a network operation.

description: The protocol and transport that is used for communicating with Event Hubs.

description: The proxy to use for communicating with Event Hubs over web sockets. A proxy cannot be used with the amqpTcp transport.

description: The address to use when establishing a connection to Event Hubs, allowing network requests to be routed through an application gateway or other path needed for the host environment.

description: The location in the event stream to start processing when a checkpoint does not exist in storage. Applies to all partitions.

description: Specifies the enqueued time of the event in the stream from which to start processing. When initialOffsetOptions/type is configured as fromEnqueuedTime, this setting is mandatory. Supports time in any format supported by DateTime.Parse(), such as 2020-10-26T20:31Z.

description: The approach to use for calculating retry delays. Exponential mode will retry attempts with a delay based on a back-off strategy where each attempt will increase the duration that it waits before retrying.

description: The maximum duration to wait for an Event Hubs operation to complete, per attempt.

description: The maximum delay to allow between retry attempts.

description: The maximum number of retry attempts before considering the associated operation to have failed.

description: The number of batches to process before creating an EventHub cursor checkpoint.

description: Configuration on processing event hub events.

description: The location in the event stream from which to start processing when a checkpoint doesn't exist in storage.

description: The default prefetch that will be used by the underlying EventProcessorHost.

description: The number of event batches to process before creating an EventHub cursor checkpoint.

description: The number of concurrent invocations allowed for each blob-triggered function.

description: The number of times to try processing a message before moving it to the poison queue.

description: Configuration settings for dynamic concurrency

description: Enables or disables dynamic concurrency for function apps.

description: Enables or disables the learned concurrency values persisting in storage.

title: JSON schema for Azure Functions host.json files


size-limit.json

title: Configuration Section

title: relative path to files

title: relative paths to files

title: Path or Glob Pattern

title: partial import to test tree-shaking

title: size or time limit for files from the path option. It should be a string with a number and unit, separated by a space.

title: the name of the current section. It will only be useful if you have multiple sections.

title: when using a custom webpack config, a webpack entry could be given. It could be a string or an array of strings. By default, the total size of all entry points will be checked.

title: with false it will disable webpack.

title: with false it will disable calculating running time.

title: with false it will disable gzip compression.

title: with true it will use brotli compression and disable gzip compression.

title: an array of files and dependencies to exclude from the project size calculation.

title: a path to a custom webpack config.

title: JSON Schema for configuration for size-limit


$comment: JSON Schema for CRYENGINE 5.4

title: Variable name

description: CVar name

title: Command name

description: Console command name

$ref: #/definitions/cvars

title: Value of the CVar

description: The default value of the CVar

required: name value

title: Assets folder

description: This indicates where the assets are stored

default: Assets

title: Code folder

description: This indicates where the code is stored

default: Code

title: Lib's name

title: Lib's name to import for all the supported platforms

title: Lib's name to import for the win_x64 platform

title: Lib's name to import for the win_x86 platform

title: Project name

description: This indicates the project name

title: Project GUID

title: Engine version

description: This indicates which engine version will be used

title: Plugin name

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby

title: Plugin type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one

title: This plugin will be used only by these platforms

enum: pc ps4 xboxone linux

required: path type

title: Project version

$ref: #/definitions/commands

title: Value of the command

description: Arguments that has to be passed to the command. Leave empty if it has not parameters

required: content info require version

title: CryProj schema