Add required column to docs
Signed-off-by: David Arendsen <darendsen@gamepoint.com>
This commit is contained in:
parent
221238283a
commit
c728f721e5
6 changed files with 27 additions and 2 deletions
|
|
@ -8,21 +8,25 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
|
<th>Required</th>
|
||||||
<th>Data type</th>
|
<th>Data type</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>every</td>
|
<td>every</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Duration of time between windows.</td>
|
<td>Duration of time between windows.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>fn</td>
|
<td>fn</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Aggregate or selector function to apply to each time window.</td>
|
<td>Aggregate or selector function to apply to each time window.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>options</td>
|
<td>options</td>
|
||||||
|
<td>No</td>
|
||||||
<td>array</td>
|
<td>array</td>
|
||||||
<td>
|
<td>
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
||||||
|
|
@ -8,20 +8,22 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
|
<th>Required</th>
|
||||||
<th>Data type</th>
|
<th>Data type</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>column</td>
|
<td>column</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Column to duplicate.</td>
|
<td>Column to duplicate.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>as</td>
|
<td>as</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Name to assign to the duplicate column.</td>
|
<td>Name to assign to the duplicate column.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,18 +8,30 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
|
<th>Required</th>
|
||||||
<th>Data type</th>
|
<th>Data type</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>columns</td>
|
<td>columns</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>array</td>
|
<td>array</td>
|
||||||
<td>List of columns to use in the grouping operation.</td>
|
<td>List of columns to use in the grouping operation.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>mode</td>
|
<td>mode</td>
|
||||||
|
<td>No</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Grouping mode. Default is 'by'.</td>
|
<td>
|
||||||
|
Grouping mode. Default is 'by'. <br/>Available modes:
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
by: Group by columns defined in the columns parameter.
|
||||||
|
</li>
|
||||||
|
<li>except: Group by all columns except those in defined in the columns parameter.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -8,16 +8,19 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
|
<th>Required</th>
|
||||||
<th>Data type</th>
|
<th>Data type</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>n</td>
|
<td>n</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>integer</td>
|
<td>integer</td>
|
||||||
<td>Maximum number of rows to return.</td>
|
<td>Maximum number of rows to return.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>offset</td>
|
<td>offset</td>
|
||||||
|
<td>No</td>
|
||||||
<td>integer</td>
|
<td>integer</td>
|
||||||
<td>Number of rows to skip per table before limiting to <u>n</u>. Default is 0.</td>
|
<td>Number of rows to skip per table before limiting to <u>n</u>. Default is 0.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
|
||||||
|
|
@ -8,11 +8,13 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
|
<th>Required</th>
|
||||||
<th>Data type</th>
|
<th>Data type</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>column</td>
|
<td>column</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Column to use to compute means. Default is '_value'.</td>
|
<td>Column to use to compute means. Default is '_value'.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
|
||||||
|
|
@ -8,11 +8,13 @@
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Name</th>
|
<th>Name</th>
|
||||||
|
<th>Required</th>
|
||||||
<th>Data type</th>
|
<th>Data type</th>
|
||||||
<th>Description</th>
|
<th>Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>input</td>
|
<td>input</td>
|
||||||
|
<td>Yes</td>
|
||||||
<td>string</td>
|
<td>string</td>
|
||||||
<td>Insert any Flux function here.</td>
|
<td>Insert any Flux function here.</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
|
||||||
Loading…
Add table
editor.link_modal.header
Reference in a new issue