durbok/noodl-docs
1
0
Fork 0
mirror of https://github.com/noodlapp/noodl-docs.git synced 2026-01-12 07:12:53 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: Upgrade Docusaurus from v2 to v3 (#52)

Browse Source 
* chore: Upgrade Docusaurus from v2 to v3

* chore: Update "Test build" GH workflow

* fix: build

All markdown is processed as MDX

* fix: Broken links
This commit is contained in:
Eric Tuvesson
2024-01-12 16:53:22 +01:00
committed by GitHub
parent 65b0cf0417
commit 656e5fc8d2
156 changed files with 4854 additions and 10445 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
nodes/data/array/array-filter/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Array Filter node
---
<##head##>
{/*##head##*/}
# Array Filter
@@ -16,7 +16,7 @@ This node will take an array of items as input and output a filtered version of
</div>
<##head##>
{/*##head##*/}
## Inputs
@@ -24,15 +24,15 @@ This node will take an array of items as input and output a filtered version of
| Data | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Enabled</span> | <##input:enabled##>The filtering is enabled by default, if disabled the array will simply pass through unfiltered.<##input##> |
| <span className="ndl-data">Items</span> | <##input:items##>The array that should be filtered.<##input##> |
| <span className="ndl-data">Use Limit</span> | <##input:filterEnableLimit##>Enables or disables limiting the number of objects in the outputted items array.<##input##> |
| <span className="ndl-data">Limit</span> | <##input:filterLimit##>Specify the maximum number of objects in the filtered output.<##input##> |
| <span className="ndl-data">Skip</span> | <##input:filterSkip##>Specify the number of objects to skip from the beginning of the filtered output.<##input##> |
| <span className="ndl-data">Enabled</span> | {/*##input:enabled##*/}The filtering is enabled by default, if disabled the array will simply pass through unfiltered.{/*##input##*/} |
| <span className="ndl-data">Items</span> | {/*##input:items##*/}The array that should be filtered.{/*##input##*/} |
| <span className="ndl-data">Use Limit</span> | {/*##input:filterEnableLimit##*/}Enables or disables limiting the number of objects in the outputted items array.{/*##input##*/} |
| <span className="ndl-data">Limit</span> | {/*##input:filterLimit##*/}Specify the maximum number of objects in the filtered output.{/*##input##*/} |
| <span className="ndl-data">Skip</span> | {/*##input:filterSkip##*/}Specify the number of objects to skip from the beginning of the filtered output.{/*##input##*/} |
| Signal | Description |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Filter</span> | <##input:filter##>By default the node will filter as soon as there is a new array on the _Items_ input or if that array changes. But if there is a connection to the _Filter_ input it will wait until a signal is sent here to perform the filtering.<##input##> |
| <span className="ndl-signal">Filter</span> | {/*##input:filter##*/}By default the node will filter as soon as there is a new array on the _Items_ input or if that array changes. But if there is a connection to the _Filter_ input it will wait until a signal is sent here to perform the filtering.{/*##input##*/} |
### Filter
@@ -63,7 +63,7 @@ The available operations of the filter depend on the type that is set.
?> To perform a free text search on strings, use the _Matches Regexp_ operation and set the _Value_ to the partial string you want to search for.
**Value**
<##input:filterFilterValue-\*##>The value used to test against in the filter operation.<##input##>
{/*##input:filterFilterValue-\*##*/}The value used to test against in the filter operation.{/*##input##*/}
<div className="ndl-image-with-background">
@@ -88,10 +88,10 @@ For each property you can choose the sorting order.
| Data | Description |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##output:items##>The filtered and sorted array.<##output##> |
| <span className="ndl-data">Count</span> | <##output:count##>The number of objects in the filtered array.<##output##> |
| <span className="ndl-data">First Item Id</span> | <##output:firstItemId##>The _Id_ of the first object in the filtered array, or _undefined_ if there are no items in the filtered array.<##output##> |
| <span className="ndl-data">Items</span> | {/*##output:items##*/}The filtered and sorted array.{/*##output##*/} |
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of objects in the filtered array.{/*##output##*/} |
| <span className="ndl-data">First Item Id</span> | {/*##output:firstItemId##*/}The _Id_ of the first object in the filtered array, or _undefined_ if there are no items in the filtered array.{/*##output##*/} |
| Signal | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Filtered</span> | <##output:filtered##>Signal emitted when the array has been filtered, either due to a _Filter_ signal sent or if the array has changed.<##output##> |
| <span className="ndl-signal">Filtered</span> | {/*##output:filtered##*/}Signal emitted when the array has been filtered, either due to a _Filter_ signal sent or if the array has changed.{/*##output##*/} |

12
nodes/data/array/array-map/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Array Map node
---
<##head##>
{/*##head##*/}
# Array Map
@@ -16,13 +16,13 @@ This node takes an input array, runs a small map script on each item, and output
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------- | ------------------------------------------------------------ |
| <span className="ndl-data">Items</span> | <##input:items##>The array that should be mapped.<##input##> |
| <span className="ndl-data">Items</span> | {/*##input:items##*/}The array that should be mapped.{/*##input##*/} |
### Script
@@ -54,9 +54,9 @@ Note that the objects that are created when mapping are new objects so they will
| Data | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##output:items##>The mapped array.<##output##> |
| <span className="ndl-data">Count</span> | <##output:count##>The number of items in the mapped array (this will be the same as the input array)<##output##> |
| <span className="ndl-data">Items</span> | {/*##output:items##*/}The mapped array.{/*##output##*/} |
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of items in the mapped array (this will be the same as the input array){/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Changed</span> | <##output:changed##>A signal is emitted here when the input array has been modified which will trigger the _Array Map_ node to remap the input and produce a new output _Items_.<##output##> |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}A signal is emitted here when the input array has been modified which will trigger the _Array Map_ node to remap the input and produce a new output _Items_.{/*##output##*/} |

20
nodes/data/array/array-node/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Array node
---
<##head##>
{/*##head##*/}
# Array
@@ -17,7 +17,7 @@ Arrays are ordered lists of [Object](/nodes/data/object/object-node)s. See the g
</div>
You can create and modify the array using the [Create new Array](/nodes/data/array/create-new-array), [Insert Object Into Array](/nodes/data/array/insert-into-array) and [Remove Object From Array](/nodes/data/array/remove-from-array).
<##head##>
{/*##head##*/}
## Inputs
@@ -25,22 +25,22 @@ You can create and modify the array using the [Create new Array](/nodes/data/arr
| Data | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##input:items##>This input sets the source of the array.<##input##> You can for instance forward the content of a [Static Array](/nodes/data/array/static-array) node using this input. The content of the source array will be copied to this array by default and any changes to the source array will also be copied automatically. You can control this by making a signal connection to _Set_, in that case the items, i.e. content of the source array, will only be copied when a signal is received on _Set_. |
| <span className="ndl-data">Id</span> | <##input:id##>This is the _Id_ of the array, it works similair to objects and variables. It specifies the array that this node will act on via it's _Id_. All **Array** nodes with the same _Id_ will refer to the same array of objects.<##input##> |
| <span className="ndl-data">Items</span> | {/*##input:items##*/}This input sets the source of the array.{/*##input##*/} You can for instance forward the content of a [Static Array](/nodes/data/array/static-array) node using this input. The content of the source array will be copied to this array by default and any changes to the source array will also be copied automatically. You can control this by making a signal connection to _Set_, in that case the items, i.e. content of the source array, will only be copied when a signal is received on _Set_. |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}This is the _Id_ of the array, it works similair to objects and variables. It specifies the array that this node will act on via it's _Id_. All **Array** nodes with the same _Id_ will refer to the same array of objects.{/*##input##*/} |
| Signal | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Fetch</span> | <##input:fetch##>Normally when _Id_ is set, the items and count outputs are immediately updated with the content of the array referenced by the _Id_. If you want to control how the data is updated you can connect to the _Fetch_ signal input. Then you need to explictly send a signal here for the **Array** node to fetch the data. Before an array have been fetched none of the modify and set operations or source items will have any affect.<##input##> |
| <span className="ndl-signal">Fetch</span> | {/*##input:fetch##*/}Normally when _Id_ is set, the items and count outputs are immediately updated with the content of the array referenced by the _Id_. If you want to control how the data is updated you can connect to the _Fetch_ signal input. Then you need to explictly send a signal here for the **Array** node to fetch the data. Before an array have been fetched none of the modify and set operations or source items will have any affect.{/*##input##*/} |
## Outputs
| Data | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The _Id_ for this **Array**.<##output##> |
| <span className="ndl-data">Items</span> | <##output:items##>This is an output that can be connected to others that can take **Array** inputs, such as the [Repeater](/nodes/ui-controls/repeater) node. It will hold an `Noodl.Array` type.<##output##> |
| <span className="ndl-data">Count</span> | <##output:count##>The number of items in the **Array**.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The _Id_ for this **Array**.{/*##output##*/} |
| <span className="ndl-data">Items</span> | {/*##output:items##*/}This is an output that can be connected to others that can take **Array** inputs, such as the [Repeater](/nodes/ui-controls/repeater) node. It will hold an `Noodl.Array` type.{/*##output##*/} |
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of items in the **Array**.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Changed</span> | <##output:changed##>This signal is triggered when the content of the array is changed, either by an action on this node or by some other node in the graph that operates on the same array Id.<##output##> |
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>Triggered when a _Fetch_ action has been performed and the data is ready.<##output##> |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}This signal is triggered when the content of the array is changed, either by an action on this node or by some other node in the graph that operates on the same array Id.{/*##output##*/} |
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}Triggered when a _Fetch_ action has been performed and the data is ready.{/*##output##*/} |

10
nodes/data/array/clear-array/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Clear Array node
---
<##head##>
{/*##head##*/}
# Clear Array
@@ -16,20 +16,20 @@ This node is used to remove all _Objects_ from an _Array_. The Array is referred
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------ |
| <span className="ndl-data">Array Id</span> | <##input:collectionId##>The _Id_ of the Array that will be cleared.<##input##> |
| <span className="ndl-data">Array Id</span> | {/*##input:collectionId##*/}The _Id_ of the Array that will be cleared.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>This actions removes all the Objects from the Array with the _Id_ set on the input _Array Id_.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}This actions removes all the Objects from the Array with the _Id_ set on the input _Array Id_.{/*##input##*/} |
## Outputs
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Done</span> | <##output:done##>This event is sent when the removal is done, and the Array is empty.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}This event is sent when the removal is done, and the Array is empty.{/*##output##*/} |

12
nodes/data/array/create-new-array/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Create New Array node
---
<##head##>
{/*##head##*/}
# Create New Array
@@ -16,24 +16,24 @@ Creates a new Array. The outgoing property _Id_ is the id of the newly created a
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##input:items##>An array containing initial items of the new array. It will be read when the _Do_ signal is triggered. In other words, the new Array will be a copy of the provided Array, containing the same Objects.<##input##> |
| <span className="ndl-data">Items</span> | {/*##input:items##*/}An array containing initial items of the new array. It will be read when the _Do_ signal is triggered. In other words, the new Array will be a copy of the provided Array, containing the same Objects.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Sending a signal to this input creates the new Array. The _Id_ of the newly created array will be set on the _Id_ output. Each triggering will create a new Array, hence changing the _Id_ output.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Sending a signal to this input creates the new Array. The _Id_ of the newly created array will be set on the _Id_ output. Each triggering will create a new Array, hence changing the _Id_ output.{/*##input##*/} |
## Outputs
| Data | Description |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The Id of the newly created Array. You use this Id to refer to the Array.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The Id of the newly created Array. You use this Id to refer to the Array.{/*##output##*/} |
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Done</span> | <##output:done##>This signal will be sent when the new Array has been created.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}This signal will be sent when the new Array has been created.{/*##output##*/} |

12
nodes/data/array/insert-into-array/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Insert Into Array node
---
<##head##>
{/*##head##*/}
# Insert Object Into Array
@@ -16,21 +16,21 @@ This node is used to insert an _Object_ into an _Array_. Both the Array and the
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------- |
| <span className="ndl-data">Array Id</span> | <##input:collectionId##>The _Id_ of the Array to insert the Object into.<##input##> |
| <span className="ndl-data">Object Id</span> | <##input:modifyId##>The _Id_ of the Object to insert into the Array.<##input##> |
| <span className="ndl-data">Array Id</span> | {/*##input:collectionId##*/}The _Id_ of the Array to insert the Object into.{/*##input##*/} |
| <span className="ndl-data">Object Id</span> | {/*##input:modifyId##*/}The _Id_ of the Object to insert into the Array.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Sending a signal to this input inserts the Object with the _Id_ set on the input _Object Id_ into the Array with the _Id_ set on the input _Array Id_.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Sending a signal to this input inserts the Object with the _Id_ set on the input _Object Id_ into the Array with the _Id_ set on the input _Array Id_.{/*##input##*/} |
## Outputs
| Signal | Description |
| ---------------------------------------- | ----------------------------------------------------------------------------- |
| <span className="ndl-signal">Done</span> | <##output:done##>This signal is sent when the insertion is ready.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}This signal is sent when the insertion is ready.{/*##output##*/} |

12
nodes/data/array/remove-from-array/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Remove From Array node
---
<##head##>
{/*##head##*/}
# Remove Object From Array
@@ -17,21 +17,21 @@ If the _Object_ to be removed is not in the array, nothing will happen.
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Array Id</span> | <##input:collectionId##>The _Id_ of the Array from which the Object will be removed.<##input##> |
| <span className="ndl-data">Object Id</span> | <##input:modifyId##>The _Id_ of the Object to remove from the Array.<##input##> |
| <span className="ndl-data">Array Id</span> | {/*##input:collectionId##*/}The _Id_ of the Array from which the Object will be removed.{/*##input##*/} |
| <span className="ndl-data">Object Id</span> | {/*##input:modifyId##*/}The _Id_ of the Object to remove from the Array.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>This actions removes the Object with the _Id_ set on the input _Object Id_ from the Array with the _Id_ set on the input _Array Id_.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}This actions removes the Object with the _Id_ set on the input _Object Id_ from the Array with the _Id_ set on the input _Array Id_.{/*##input##*/} |
## Outputs
| Signal | Description |
| ---------------------------------------- | -------------------------------------------------------------------------- |
| <span className="ndl-signal">Done</span> | <##output:done##>This signal is sent when the removal is done.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}This signal is sent when the removal is done.{/*##output##*/} |

50
nodes/data/array/static-array/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Static Array node
---
<##head##>
{/*##head##*/}
# Static Array
@@ -16,8 +16,10 @@ Store static data to populate an [Array](/nodes/data/array/array-node) with item
</div>
You can provide the data in either **CSV** format or, **JSON** format. The **items** output is of **Noodl.Array** format. The content of the array is reset whenever the application is refreshed.
<##head##>
You can provide the data in either **CSV** format or, **JSON** format. The **items** output is of **Noodl.Array** format.
The content of the array is reset whenever the application is refreshed.
{/*##head##*/}
## Inputs
@@ -30,33 +32,37 @@ You can provide the data in either **CSV** format or, **JSON** format. The **ite
The first row defines the name of all properties. Subsequent rows defines the data values.
Example:
lamp,topic
Kitchen Lamp,/lamps/1
Office Lamp,/lamps/2
Office Lamp 2,/lamps/4
```
lamp,topic
Kitchen Lamp,/lamps/1
Office Lamp,/lamps/2
Office Lamp 2,/lamps/4
```
### JSON
Define the name of the properties, and the data, using a JSON array.
Example:
[
{
"lamp": "Kitchen Lamp",
"topic": "/lamps/1"
},
{
"lamp": "Office Lamp",
"topic": "/lamps/2"
},
{
"lamp": "Office Lamp 2",
"topic": "/lamps/4"
}
]
```json
[
{
"lamp": "Kitchen Lamp",
"topic": "/lamps/1"
},
{
"lamp": "Office Lamp",
"topic": "/lamps/2"
},
{
"lamp": "Office Lamp 2",
"topic": "/lamps/4"
}
]
```
## Outputs
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##output:items##>A `Noodl.Array` object that can be connected to e.g. an [Array](/nodes/data/array/array-node), [JavaScript](/docs/guides/business-logic/javascript) or [Repeater](/nodes/ui-controls/repeater).<##output##> |
| <span className="ndl-data">Items</span> | {/*##output:items##*/}A `Noodl.Array` object that can be connected to e.g. an [Array](/nodes/data/array/array-node), [JavaScript](/docs/guides/business-logic/javascript) or [Repeater](/nodes/ui-controls/repeater).{/*##output##*/} |

4
nodes/data/boolean/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Boolean node
---
<##head##>
{/*##head##*/}
# Boolean
@@ -24,7 +24,7 @@ You can connect the <span className="ndl-node">Boolean</span> node to a <span cl
</div>
<##head##>
{/*##head##*/}
## Inputs

18
nodes/data/cloud-data/add-record-relation/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Add Record Relation node
---
<##head##>
{/*##head##*/}
# Add Record Relation
@@ -22,31 +22,31 @@ You need to provide the <span className="ndl-data">Id</span> of the owning recor
Finally, send a <span className="ndl-signal">signal</span> to <span className="ndl-signal">Do</span> to perform the action.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | The **Class** of the owning record where you want to add the related object to. |
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to use as the owning record to add a relation to.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to use as the owning record to add a relation to.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Relation</span> | You need to choose the **Relation** property of the owning class to use when creating the relation. |
| <span className="ndl-data">Target Record Id</span> | <##input:target record id##>This input should be connected to the **Id** of the target record of the new relation.<##input##> |
| <span className="ndl-data">Target Record Id</span> | {/*##input:target record id##*/}This input should be connected to the **Id** of the target record of the new relation.{/*##input##*/} |
@include "../_id-source.md"
| Signal | Description |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the relation will be created in the backend.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the relation will be created in the backend.{/*##input##*/} |
## Outputs
| Data | Description |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>This is the **Id** of the owning record that have / will receive the new relation. It is simply a mirror of the **Id** input.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>The error message in case something went wrong when attempting to add the relation in the backend.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}This is the **Id** of the owning record that have / will receive the new relation. It is simply a mirror of the **Id** input.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The error message in case something went wrong when attempting to add the relation in the backend.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent on this output when the relation has been added successfully in the backend.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when adding the relation in the backend. The error message will be outputed on the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent on this output when the relation has been added successfully in the backend.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when adding the relation in the backend. The error message will be outputed on the **Error** output.{/*##output##*/} |

10
nodes/data/cloud-data/cloud-file/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Cloud File node
---
<##head##>
{/*##head##*/}
# Cloud File
@@ -23,17 +23,17 @@ Represents a file that has been uploaded to the Noodl Cloud Services and stored
![](/nodes/data/cloud-data/upload-file/upload-file.png)
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Cloud File</span> | <##input:cloud file##>A file that has been stored in the Noodl Cloud Services. Often used in combination with a **Record** to retrieve the **Name** and **URL** of a file.<##input##> |
| <span className="ndl-data">Cloud File</span> | {/*##input:cloud file##*/}A file that has been stored in the Noodl Cloud Services. Often used in combination with a **Record** to retrieve the **Name** and **URL** of a file.{/*##input##*/} |
## Outputs
| Data | Description |
| -------------------------------------- | -------------------------------------------------- |
| <span className="ndl-data">URL</span> | <##output:url##>The URL of the file.<##output##> |
| <span className="ndl-data">Name</span> | <##output:name##>The Name of the file.<##output##> |
| <span className="ndl-data">URL</span> | {/*##output:url##*/}The URL of the file.{/*##output##*/} |
| <span className="ndl-data">Name</span> | {/*##output:name##*/}The Name of the file.{/*##output##*/} |

14
nodes/data/cloud-data/cloud-function/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Cloud Function node
---
<##head##>
{/*##head##*/}
# Cloud Function
@@ -38,7 +38,7 @@ If a **Failure** signal is emitted you can also use the **Error** output that wi
If a **Success** signal is sent the result parameters will be available as outputs on the **Cloud Function** node.
<##head##>
{/*##head##*/}
:::note
@@ -53,25 +53,25 @@ This does not happen when running Cloud Functions locally where there is no time
| Data | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Function</span> | <##input:functionName##>The cloud function component that this node will call.<##input##> |
| <span className="ndl-data">Function</span> | {/*##input:functionName##*/}The cloud function component that this node will call.{/*##input##*/} |
### Parameters
The **Cloud Function** node will receive all parameters specified in the [Request](/nodes/cloud-functions/request) node in the cloud function component as inputs. When the <span className="ndl-signal">Call</span> signal is received the values on the inputs will be sent to the cloud funciton.
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Call</span> | <##input:call##>Send a signal on this input to issue the request to the cloud function.<##input##> |
| <span className="ndl-signal">Call</span> | {/*##input:call##*/}Send a signal on this input to issue the request to the cloud function.{/*##input##*/} |
## Outputs
| Data | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Error</span> | <##output:error##>If the cloud function results in an error status, this output will contain the error message. <##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}If the cloud function results in an error status, this output will contain the error message. {/*##output##*/} |
### Result
The **Cloud Function** node will receive all result parameters specified in any [Response](/nodes/cloud-functions/response) node in the cloud function component that is called. When the cloud function completes and retuns a **Sucess** status, any result parameters sent back will be available on these outputs.
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This is sent if the cloud function returns a **Success** status.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This is sent if the cloud function returns a **Failure** status.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This is sent if the cloud function returns a **Success** status.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This is sent if the cloud function returns a **Failure** status.{/*##output##*/} |

12
nodes/data/cloud-data/config/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Config node
---
<##head##>
{/*##head##*/}
# Config
@@ -24,7 +24,7 @@ You pick a **Parameter** in the properties of the node. First you must specify t
</div>
<##head##>
{/*##head##*/}
When creating a parameter you can specify if it requires the **Master Key** or not. Requiring the master key means that you can only access these parameters in cloud functions, which is important for config parameters that needs to be kept secure.
@@ -58,20 +58,20 @@ For the node above we want a special config parameter for when running locally s
| Data | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Parameter</span> | <##input:configKey##>The config parameter to use for this node.<##input##> |
| <span className="ndl-data">Parameter</span> | {/*##input:configKey##*/}The config parameter to use for this node.{/*##input##*/} |
## Local Override
| Data | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Enable</span> | <##input:useDevValue##>Checking this will provide a special value for this node when running in the editor or from ```localhost```<##input##> |
| <span className="ndl-data">Value</span> | <##input:devValue##>The value to return from this node when running in the editor or on ```localhost```<##input##> |
| <span className="ndl-data">Enable</span> | {/*##input:useDevValue##*/}Checking this will provide a special value for this node when running in the editor or from ```localhost```{/*##input##*/} |
| <span className="ndl-data">Value</span> | {/*##input:devValue##*/}The value to return from this node when running in the editor or on ```localhost```{/*##input##*/} |
## Outputs
| Data | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Value</span> | <##output:value##>The value for this config parameter for the current active cloud service, or the local override. <##output##> |
| <span className="ndl-data">Value</span> | {/*##output:value##*/}The value for this config parameter for the current active cloud service, or the local override. {/*##output##*/} |

18
nodes/data/cloud-data/create-new-record/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Create New Record node
---
<##head##>
{/*##head##*/}
# Create New Record
@@ -18,19 +18,19 @@ This node is used to create a new record of a given class. You specify the class
You can also provide values for the properties of the record either via connections or by typing the values in the property panel.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | Choose a class for the record that you want to create. |
| <span className="ndl-data">Source Object Id</span> | <##input:source object id##>This input can be used to provide an object whose properties will be used as the initial values of the newly created record. <##input##> |
| <span className="ndl-data">Property Inputs</span> | When the class of the record to be created is choosen, all properties of that class will be available as inputs. When the **Do** signal is received a new record will be created with the values of the properties either specified in the property panel or via connections. <##input:prop-\*##>The value of these inputs will become the properties of the newly created record.<##input##> |
| <span className="ndl-data">Source Object Id</span> | {/*##input:source object id##*/}This input can be used to provide an object whose properties will be used as the initial values of the newly created record. {/*##input##*/} |
| <span className="ndl-data">Property Inputs</span> | When the class of the record to be created is choosen, all properties of that class will be available as inputs. When the **Do** signal is received a new record will be created with the values of the properties either specified in the property panel or via connections. {/*##input:prop-\*##*/}The value of these inputs will become the properties of the newly created record.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal on this input to create a new record.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal on this input to create a new record.{/*##input##*/} |
@include "../_acl.md"
@@ -38,10 +38,10 @@ You can also provide values for the properties of the record either via connecti
| Data | Description |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the new record that was created if the action was successful.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>The specific error message in case something went wrong when creating the record.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the new record that was created if the action was successful.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The specific error message in case something went wrong when creating the record.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent here when the new record have been created successfully.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when creating the record.<##output##> You can find the specific error in the **Error** output. |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent here when the new record have been created successfully.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when creating the record.{/*##output##*/} You can find the specific error in the **Error** output. |

16
nodes/data/cloud-data/delete-record/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Delete Record node
---
<##head##>
{/*##head##*/}
# Delete Record
@@ -20,29 +20,29 @@ You will need to provide the **Id** of the record to be deleted, there are multi
Then send a signal on the **Do** input to perform the action.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | You need to select the **Class** of records that this node will act on. |
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to delete.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to delete.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
@include "../_id-source.md"
| Signal | Description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the record will be deleted on the backend.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the record will be deleted on the backend.{/*##input##*/} |
## Outputs
| Data | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the record that will be / was deleted by this node. Simply reflecting the **Id** input.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>If something went wrong when deleting the record in the backend, this output will contain the error message.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the record that will be / was deleted by this node. Simply reflecting the **Id** input.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}If something went wrong when deleting the record in the backend, this output will contain the error message.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent on this output when the record have been successfully deleted in the backend.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when attempting to delete the record in the backend.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent on this output when the record have been successfully deleted in the backend.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when attempting to delete the record in the backend.{/*##output##*/} |

26
nodes/data/cloud-data/filter-records/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Filter Record node
---
<##head##>
{/*##head##*/}
# Filter Record
@@ -23,32 +23,32 @@ You can specify both filter and sorting visually.
![](/nodes/data/cloud-data/filter-records/filter-records-visual.png)
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Enabled</span> | <##input:enabled##>If disabled the node will simply pass the input array through without change, if enabled the input array will be filtered and sorted.<##input##> |
| <span className="ndl-data">Enabled</span> | {/*##input:enabled##*/}If disabled the node will simply pass the input array through without change, if enabled the input array will be filtered and sorted.{/*##input##*/} |
| <span className="ndl-data">Class</span> | The **Class** of records that the input array is assumed to contain. |
| <span className="ndl-data">Use Limit</span> | <##input:use limit##>Enabled or disable limiting of the input array to a specific number of maximum records.<##input##> |
| <span className="ndl-data">Limit</span> | <##input:limit##>The number of maximum records to limit the output filtered array to contain.<##input##> |
| <span className="ndl-data">Skip</span> | <##input:skip##>The number of records in the beginning of the output filtered array to skip.<##input##> |
| <span className="ndl-data">Items</span> | <##input:items##>The input array of records that should be filtered by this node.<##input##> |
| <span className="ndl-data">Filter Parameter Inputs</span> | <##input:fp-\*##>Each filter parameter get an input where a connection can be made to provide the value for the paramter.<##input##> |
| <span className="ndl-data">Use Limit</span> | {/*##input:use limit##*/}Enabled or disable limiting of the input array to a specific number of maximum records.{/*##input##*/} |
| <span className="ndl-data">Limit</span> | {/*##input:limit##*/}The number of maximum records to limit the output filtered array to contain.{/*##input##*/} |
| <span className="ndl-data">Skip</span> | {/*##input:skip##*/}The number of records in the beginning of the output filtered array to skip.{/*##input##*/} |
| <span className="ndl-data">Items</span> | {/*##input:items##*/}The input array of records that should be filtered by this node.{/*##input##*/} |
| <span className="ndl-data">Filter Parameter Inputs</span> | {/*##input:fp-\*##*/}Each filter parameter get an input where a connection can be made to provide the value for the paramter.{/*##input##*/} |
| Signal | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Filter</span> | <##input:filter##>Send a signal on this input to perform the filtering, this will produce a new filtered array on the **Items** output. If this input does not have a connection, the input array will be filtered every time it is updated.<##input##> |
| <span className="ndl-signal">Filter</span> | {/*##input:filter##*/}Send a signal on this input to perform the filtering, this will produce a new filtered array on the **Items** output. If this input does not have a connection, the input array will be filtered every time it is updated.{/*##input##*/} |
## Outputs
| Data | Description |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##output:items##>This output will contain the filtered array of records.<##output##> |
| <span className="ndl-data">Count</span> | <##output:count##>The number of records in the filtered output array.<##output##> |
| <span className="ndl-data">First Record Id</span> | <##output:first record id##>The **Id** of the first record in the filtered output array.<##output##> |
| <span className="ndl-data">Items</span> | {/*##output:items##*/}This output will contain the filtered array of records.{/*##output##*/} |
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of records in the filtered output array.{/*##output##*/} |
| <span className="ndl-data">First Record Id</span> | {/*##output:first record id##*/}The **Id** of the first record in the filtered output array.{/*##output##*/} |
| Signal | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Filtered</span> | <##output:filtered##>A signal will be sent on this output when the input array have been successfully filtered.<##output##> |
| <span className="ndl-signal">Filtered</span> | {/*##output:filtered##*/}A signal will be sent on this output when the input array have been successfully filtered.{/*##output##*/} |

30
nodes/data/cloud-data/query-records/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Query Records node
---
<##head##>
{/*##head##*/}
# Query Records
@@ -24,7 +24,7 @@ You can specify the query using filter, sorting and limit in the Property Panel.
</div>
<##head##>
{/*##head##*/}
## Filters
@@ -320,27 +320,27 @@ sort(["-Age", "createdAt"]);
| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | Select the **Class** for the types of records this node should query. When the **Class** is selected you can create filters and sorting based on the properties of the **Class**. |
| <span className="ndl-data">Filter</span> | This specifies the type of filter, you can choose from:<br/><br/>`Visual`: Specify your filter using the visual filter editor.<br/>`JavaScript`: Specify your filter using JavaScript (this is more flexible and you can create more dynamic queyries but it's also more complex) |
| <span className="ndl-data">Use Limit</span> | <##input:use limit##>Enable or disable the use of limit, i.e. that you can specify how many records are returned as a maximum and if a number of record should be skipped.<##input##> |
| <span className="ndl-data">Limit</span> | <##input:limit##>The maximum number of records to be returned by the backend.<##input##> |
| <span className="ndl-data">Skip</span> | <##input:skip##>This property allows you to skip a number of records from being returned by the backend. Using **Skip** and **Limit** allows you to do paging, e.g. return records from 10-20.<##input##> |
| <span className="ndl-data">Fetch Total Count</span> | <##input:storageEnableCount##>Enable this to also query for the total count of records matching the filters. Even if you limit the returned result. <##input##> |
| <span className="ndl-data">Query Parameters</span> | <##input:qp-\*##>The input for specifying the value of a query parameter.<##input##> Each paramteter used in your query will get an input where you can provide a value through a connection.<##input##> |
| <span className="ndl-data">Use Limit</span> | {/*##input:use limit##*/}Enable or disable the use of limit, i.e. that you can specify how many records are returned as a maximum and if a number of record should be skipped.{/*##input##*/} |
| <span className="ndl-data">Limit</span> | {/*##input:limit##*/}The maximum number of records to be returned by the backend.{/*##input##*/} |
| <span className="ndl-data">Skip</span> | {/*##input:skip##*/}This property allows you to skip a number of records from being returned by the backend. Using **Skip** and **Limit** allows you to do paging, e.g. return records from 10-20.{/*##input##*/} |
| <span className="ndl-data">Fetch Total Count</span> | {/*##input:storageEnableCount##*/}Enable this to also query for the total count of records matching the filters. Even if you limit the returned result. {/*##input##*/} |
| <span className="ndl-data">Query Parameters</span> | {/*##input:qp-\*##*/}The input for specifying the value of a query parameter.{/*##input##*/} Each paramteter used in your query will get an input where you can provide a value through a connection.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal here to perform the query and fetch matching records from the backend.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal here to perform the query and fetch matching records from the backend.{/*##input##*/} |
## Outputs
| Data | Description |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Items</span> | <##output:items##>The result of the query as an array of **Records**.<##output##> |
| <span className="ndl-data">Count</span> | <##output:count##>The number of records in the result.<##output##> |
| <span className="ndl-data">First Record Id</span> | <##output:first record id##>The Id of the first Record in the result array.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>This output contains the error message incase something when wrong when executing the query.<##output##> |
| <span className="ndl-data">Total Count</span> | <##output:storageTotalCount##>If **Fetch Total Count** is enabled then this output will contain the total number of records that match the query. Even if you limit the returned result.<##output##> |
| <span className="ndl-data">Items</span> | {/*##output:items##*/}The result of the query as an array of **Records**.{/*##output##*/} |
| <span className="ndl-data">Count</span> | {/*##output:count##*/}The number of records in the result.{/*##output##*/} |
| <span className="ndl-data">First Record Id</span> | {/*##output:first record id##*/}The Id of the first Record in the result array.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output contains the error message incase something when wrong when executing the query.{/*##output##*/} |
| <span className="ndl-data">Total Count</span> | {/*##output:storageTotalCount##*/}If **Fetch Total Count** is enabled then this output will contain the total number of records that match the query. Even if you limit the returned result.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent here if the query was successful and the result is ready.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent here if something went wrong with the query. You can find the error message via the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent here if the query was successful and the result is ready.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent here if something went wrong with the query. You can find the error message via the **Error** output.{/*##output##*/} |

22
nodes/data/cloud-data/record/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Record node
---
<##head##>
{/*##head##*/}
# Record
@@ -19,32 +19,32 @@ This node is used to read data from a **Record**. A **Record** is an **Object**
You have to choose the class for the **Record** node in the property panel and you must make sure that the node has the Id of the record it should access (there are multiple ways to do this, see full docs for details).
Then you can access the properties of the specific **Record** through the property outputs.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | Select the **Class** for this Records that this node will get data from. Choosing the **Class** will make the node get all properties of the class as outputs. |
| <span className="ndl-data">Id</span> | <##input:id##>The Id of the **Record** that this node should read data from.<##input##> |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}The Id of the **Record** that this node should read data from.{/*##input##*/} |
@include "../_id-source.md"
| Signal | Description |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetch</span> | <##input:fetch##>Send a signal on this input to fetch the data for this **Record** from the backend. All **Record** nodes that share the **Id** with this node (i.e. are reading data from the same record) will be updated.<##input##> |
| <span className="ndl-signal">Fetch</span> | {/*##input:fetch##*/}Send a signal on this input to fetch the data for this **Record** from the backend. All **Record** nodes that share the **Id** with this node (i.e. are reading data from the same record) will be updated.{/*##input##*/} |
## Outputs
| Data | Description |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The Id of the **Record** this node is accessing the properties for.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>This will contain the error message if a fetch action failed and the **Failure** signal was emitted.<##output##> |
| <span className="ndl-data">Class Properties</span> | <##output:prop-\*##>The value of this property in the record that the node reads from.<##output##> This node will have an output for each property in the **Class** that have been selected on the node. |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The Id of the **Record** this node is accessing the properties for.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This will contain the error message if a fetch action failed and the **Failure** signal was emitted.{/*##output##*/} |
| <span className="ndl-data">Class Properties</span> | {/*##output:prop-\*##*/}The value of this property in the record that the node reads from.{/*##output##*/} This node will have an output for each property in the **Class** that have been selected on the node. |
| Signal | Description |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>A signal is sent on this output when a **Fetch** has been completed successfully. This is as a result of triggering a fetch by sending a signal to the **Fetch** input.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if a fetch action has failed. This is a potential result of triggering a fetch by sending a signal to the **Fetch** input.<##output##> |
| <span className="ndl-signal">Changed</span> | <##output:changed##>A signal is sent on this output if the record that this node is reading data from has changed locally.<##output##> |
| <span className="ndl-signal">Property Changed Signal</span> | <##output:changed-\*##>A signal is sent here if the value of the property on the record this node is reading data from has changed locally.<##output##> |
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}A signal is sent on this output when a **Fetch** has been completed successfully. This is as a result of triggering a fetch by sending a signal to the **Fetch** input.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if a fetch action has failed. This is a potential result of triggering a fetch by sending a signal to the **Fetch** input.{/*##output##*/} |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}A signal is sent on this output if the record that this node is reading data from has changed locally.{/*##output##*/} |
| <span className="ndl-signal">Property Changed Signal</span> | {/*##output:changed-\*##*/}A signal is sent here if the value of the property on the record this node is reading data from has changed locally.{/*##output##*/} |

18
nodes/data/cloud-data/remove-record-relation/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Remove Record Relation node
---
<##head##>
{/*##head##*/}
# Remove Record Relation
@@ -22,31 +22,31 @@ You need to provide the <span className="ndl-data">Id</span> of the owning recor
Finally, send a <span className="ndl-signal">signal</span> to <span className="ndl-signal">Do</span> to perform the action.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | The **Class** of the owning record where you want to remove the relation from. |
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to use as the owning record to remove an existing relation from.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to use as the owning record to remove an existing relation from.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Relation</span> | You need to choose the **Relation** property of the owning class to use when removing the relation. |
| <span className="ndl-data">Target Record Id</span> | <##input:target record id##>This input should be connected to the **Id** of the target record that have an existing relation to the owning record via the **Relation** property that should be removed.<##input##> |
| <span className="ndl-data">Target Record Id</span> | {/*##input:target record id##*/}This input should be connected to the **Id** of the target record that have an existing relation to the owning record via the **Relation** property that should be removed.{/*##input##*/} |
@include "../_id-source.md"
| Signal | Description |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the relation will be removed in the backend, if it exists.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the relation will be removed in the backend, if it exists.{/*##input##*/} |
## Outputs
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>This is the **Id** of the owning record. It is simply a mirror of the **Id** input.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>The error message in case something went wrong when attempting to remove the relation in the backend.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}This is the **Id** of the owning record. It is simply a mirror of the **Id** input.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The error message in case something went wrong when attempting to remove the relation in the backend.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent on this output when the relation has been removed successfully in the backend.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when removing the relation in the backend. The error message will be outputed on the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent on this output when the relation has been removed successfully in the backend.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when removing the relation in the backend. The error message will be outputed on the **Error** output.{/*##output##*/} |

22
nodes/data/cloud-data/set-record-properties/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Set Record Properties node
---
<##head##>
{/*##head##*/}
# Set Record Properties
@@ -19,23 +19,23 @@ This action node will set property values of a record.
You need specify the class of the record in the property panel. Then you can either specify the values of the properties to set in the property panel or by providing them as an input connection.
Send a <span className="ndl-signal">signal</span> to <span className="ndl-signal">Do</span> to perform the action.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Class</span> | The class of record for this node. Choosing the class will determine which property inputs that become available on the node. |
| <span className="ndl-data">Store to</span> | <##input:store to##>Specifies if this node should store both to the cloud and locally, or only locally.<##input##> |
| <span className="ndl-data">Properties to store</span> | <##input:properties to store##>Specifies if only the explicitly specified properties should be save, **only specified**, this means that only the properties that have a value either in the property panel or via an input connection will be written to the cloud record. If **All** is selected that means that all properties will always be written, if there is no explicit value provided on this node the value of the object with the corresponding **Id** will be used.<##input##> |
| <span className="ndl-data">Id</span> | <##input:id##>Specify the **Id** of the record that you want to set the properties on.<##input##> This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Property Inputs</span> | <##input:prop-\*##>The value to set this property to when the action is triggered.<##input##> For each property in the specified class there will be an input of the correct type. You can provide the values for the inputs either through connections or by specifying them in the property panel. |
| <span className="ndl-data">Store to</span> | {/*##input:store to##*/}Specifies if this node should store both to the cloud and locally, or only locally.{/*##input##*/} |
| <span className="ndl-data">Properties to store</span> | {/*##input:properties to store##*/}Specifies if only the explicitly specified properties should be save, **only specified**, this means that only the properties that have a value either in the property panel or via an input connection will be written to the cloud record. If **All** is selected that means that all properties will always be written, if there is no explicit value provided on this node the value of the object with the corresponding **Id** will be used.{/*##input##*/} |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Specify the **Id** of the record that you want to set the properties on.{/*##input##*/} This input is only valid if **Id Source** is set to **Specify explicitly**. |
| <span className="ndl-data">Property Inputs</span> | {/*##input:prop-\*##*/}The value to set this property to when the action is triggered.{/*##input##*/} For each property in the specified class there will be an input of the correct type. You can provide the values for the inputs either through connections or by specifying them in the property panel. |
@include "../_id-source.md"
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>When a signal is received on this input the properties will be set on the record.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}When a signal is received on this input the properties will be set on the record.{/*##input##*/} |
@include "../_acl.md"
@@ -43,10 +43,10 @@ Send a <span className="ndl-signal">signal</span> to <span className="ndl-signal
| Data | Description |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the record where the properties will be updated by this node.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>The specific error message in case something went wrong when updating the record.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the record where the properties will be updated by this node.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The specific error message in case something went wrong when updating the record.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>A signal is sent here when the record have been updated successfully.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>A signal is sent on this output if something went wrong when updating the record.<##output##> You can find the specific error in the **Error** output. |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}A signal is sent here when the record have been updated successfully.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}A signal is sent on this output if something went wrong when updating the record.{/*##output##*/} You can find the specific error in the **Error** output. |

26
nodes/data/cloud-data/upload-file/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Upload File node
---
<##head##>
{/*##head##*/}
# Upload File
@@ -15,31 +15,31 @@ This node uploads a file to the Noodl Cloud Services. Can be used in combination
![](/nodes/data/cloud-data/upload-file/upload-file.png)
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">File</span> | <##input:file##>An HTML5 [File](https://developer.mozilla.org/en-US/docs/Web/API/File). The [File Picker](/nodes/utilities/open-file-picker) can be used to open a file dialog picker and generate the **File** from a local file. It's also possible to retrieve the File from external sources, or generate it by code. <##input##> |
| <span className="ndl-data">File</span> | {/*##input:file##*/}An HTML5 [File](https://developer.mozilla.org/en-US/docs/Web/API/File). The [File Picker](/nodes/utilities/open-file-picker) can be used to open a file dialog picker and generate the **File** from a local file. It's also possible to retrieve the File from external sources, or generate it by code. {/*##input##*/} |
| Signal | Description |
| ------------------------------------------ | ---------------------------------------------------------- |
| <span className="ndl-signal">Upload</span> | <##input:upload##>Triggers the upload to start.<##input##> |
| <span className="ndl-signal">Upload</span> | {/*##input:upload##*/}Triggers the upload to start.{/*##input##*/} |
## Outputs
| Data | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Cloud File</span> | <##output:cloudFile##>A [Cloud File](/nodes/data/cloud-data/cloud-file), which consists of an URL and a file name. Can be connected to a property of a [Record](/nodes/data/cloud-data/record) if the property type is specified as 'File'.<##output##> |
| <span className="ndl-data">Total Bytes</span> | <##output:progressTotalBytes##>The total size of the file in bytes that is being uploaded.<##output##> |
| <span className="ndl-data">Uploaded Bytes</span> | <##output:progressLoadedBytes##>Contains the number of bytes have been uploaded so far. Starts at 0, and moves towards **Total Bytes** after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.<##output##> |
| <span className="ndl-data">Uploaded Percent</span> | <##output:progressLoadedPercent##>The current percentage of the file that have been uploaded. Starts at 0, and moves towards 100 after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>The error message as a string, if the upload fails.<##output##> |
| <span className="ndl-data">Error Status Code</span> | <##output:errorStatus##>An [HTTP error code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). For example, `413` if the file is too large.<##output##> |
| <span className="ndl-data">Cloud File</span> | {/*##output:cloudFile##*/}A [Cloud File](/nodes/data/cloud-data/cloud-file), which consists of an URL and a file name. Can be connected to a property of a [Record](/nodes/data/cloud-data/record) if the property type is specified as 'File'.{/*##output##*/} |
| <span className="ndl-data">Total Bytes</span> | {/*##output:progressTotalBytes##*/}The total size of the file in bytes that is being uploaded.{/*##output##*/} |
| <span className="ndl-data">Uploaded Bytes</span> | {/*##output:progressLoadedBytes##*/}Contains the number of bytes have been uploaded so far. Starts at 0, and moves towards **Total Bytes** after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.{/*##output##*/} |
| <span className="ndl-data">Uploaded Percent</span> | {/*##output:progressLoadedPercent##*/}The current percentage of the file that have been uploaded. Starts at 0, and moves towards 100 after the **Upload** input signal has been triggered. The value is updated each time the **Progress Changed** event is sent.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}The error message as a string, if the upload fails.{/*##output##*/} |
| <span className="ndl-data">Error Status Code</span> | {/*##output:errorStatus##*/}An [HTTP error code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). For example, `413` if the file is too large.{/*##output##*/} |
| Signal | Description |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Progress Changed</span> | <##output:progressChanged##>This event is used to track the upload progress. It is triggered multiple times during an upload when **Uploaded Bytes** and **Uploaded Percent** are updated.<##output##> |
| <span className="ndl-signal">Success</span> | <##output:success##>This event triggers when the file was uploaded successfully.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event triggers if there was en error uploading the file.<##output##> |
| <span className="ndl-signal">Progress Changed</span> | {/*##output:progressChanged##*/}This event is used to track the upload progress. It is triggered multiple times during an upload when **Uploaded Bytes** and **Uploaded Percent** are updated.{/*##output##*/} |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event triggers when the file was uploaded successfully.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event triggers if there was en error uploading the file.{/*##output##*/} |

4
nodes/data/color/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Color node
---
<##head##>
{/*##head##*/}
# Color
@@ -18,7 +18,7 @@ This node holds a <span className="ndl-data">color</span> value.
The <span className="ndl-data">color</span> value can either be static or dynamic using the <span className="ndl-data">Value</span> and <span className="ndl-signal">Set</span> inputs.
<##head##>
{/*##head##*/}
## Inputs

4
nodes/data/number/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Number node
---
<##head##>
{/*##head##*/}
# Number
@@ -24,7 +24,7 @@ You can also use the <span className="ndl-node">Number</span> node connected to
</div>
<##head##>
{/*##head##*/}
## Inputs

2
nodes/data/object/_properties.md
View File

@@ -2,4 +2,4 @@
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Properties To Set</span> | You can specify which properties to set by adding them to this list. Object don't have a schema with predefined properties like Records so you can choose any property name you want. |
| <span className="ndl-data">Property Types</span> | Each property that you want to set will give you the option of setting the type of the value that you want to set to that property. |
| <span className="ndl-data">Property Values</span> | <##input:prop-\*##>The value to set on the Object property when the action is performed. (Signal is receieved on the **Do** input)<##input##> Each property that you want to set (that was added to the **Properties to set** section above) will get it's own input both in the property panel and as a connection input. |
| <span className="ndl-data">Property Values</span> | {/*##input:prop-\*##*/}The value to set on the Object property when the action is performed. (Signal is receieved on the **Do** input){/*##input##*/} Each property that you want to set (that was added to the **Properties to set** section above) will get it's own input both in the property panel and as a connection input. |

10
nodes/data/object/create-new-object/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Create New Object node
---
<##head##>
{/*##head##*/}
# Create New Object
@@ -18,7 +18,7 @@ The node can be used to create a fresh new [Object](/nodes/data/object/object-no
You can provide any number of properties with values for your new Object. When the **Done** signal is sent the Object is created and you can perform other actions using the Object.
<##head##>
{/*##head##*/}
## Inputs
@@ -26,14 +26,14 @@ You can provide any number of properties with values for your new Object. When t
| Signal | Description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal in this input to create the new Object with the provided properties.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal in this input to create the new Object with the provided properties.{/*##input##*/} |
## Outputs
| Data | Description |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the newly created object, this output is valid only when the **Done** signal has been sent.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the newly created object, this output is valid only when the **Done** signal has been sent.{/*##output##*/} |
| Signal | Description |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Done</span> | <##output:done##>A signal is sent on this output when the Object have been created.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}A signal is sent on this output when the Object have been created.{/*##output##*/} |

20
nodes/data/object/object-node/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Object node
---
<##head##>
{/*##head##*/}
# Object
@@ -24,7 +24,7 @@ The **Object** node is typically used together with the [Create New Object](/nod
</div>
<##head##>
{/*##head##*/}
You can also create and refer to an object statically (i.e. not using a [Create New Object](/nodes/data/object/create-new-object) by settings its **Id**. Generally, the **Id** is a global identifyer of the **Object** meaning that any **Object** nodes with the same idea will refer to the same data. If you change the properties in one **Object** node the values of all **Object** nodes with the same **Id** will be changed immediately, unless if you connect the **Fetch** signal.
@@ -42,11 +42,11 @@ Generally you use **Objects** as data holder for data that does not need to be s
| Data | Description |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Custom Properties</span> | An **Object** node can have any amount of properties. Each property will get one input and output to set/get their current value. |
| <span className="ndl-data">Id</span> | <##input:id##>Set the _Id_ for this **Object**. All **Object** nodes with the same _Id_ will refer to the same data and have the same properties.<##input##> Changing a value of any property will immediately update the property in all other **Object** nodes with the same **Id** (unless if you connect the **Fetch** signal to a specific _Object_ node, see below). |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}Set the _Id_ for this **Object**. All **Object** nodes with the same _Id_ will refer to the same data and have the same properties.{/*##input##*/} Changing a value of any property will immediately update the property in all other **Object** nodes with the same **Id** (unless if you connect the **Fetch** signal to a specific _Object_ node, see below). |
| Signal | Description |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetch</span> | <##output:fetch##>Normally when an **Object** _Id_ is set, the property outputs are immediately updated. If you want to control how the data is updated you can connect to the _Fetch_ signal input. Then you need to explictly send a signal here for the **Object** node to fetch the data.<##output##> |
| <span className="ndl-signal">Fetch</span> | {/*##output:fetch##*/}Normally when an **Object** _Id_ is set, the property outputs are immediately updated. If you want to control how the data is updated you can connect to the _Fetch_ signal input. Then you need to explictly send a signal here for the **Object** node to fetch the data.{/*##output##*/} |
## Outputs
@@ -54,17 +54,17 @@ Generally you use **Objects** as data holder for data that does not need to be s
| Data | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Id</span> | <##output:id##>The _Id_ for this **Object** node.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The _Id_ for this **Object** node.{/*##output##*/} |
| <span className="ndl-data">Custom Properties</span> | An **Object** can have any amount of properties. Each property will get one output to get the current value. |
| Signal | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Changed</span> | <##output:changed##>Signal when any of the properties of this **Object** have changed.<##output##> |
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>Signal when the **Object** has fetched and updated it's outputs. Note that the event is triggered no matter if the properties have changed or not.<##output##> |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}Signal when any of the properties of this **Object** have changed.{/*##output##*/} |
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}Signal when the **Object** has fetched and updated it's outputs. Note that the event is triggered no matter if the properties have changed or not.{/*##output##*/} |
| <span className="ndl-signal">Changed Property Signals</span> | An **Object** will also get changed signal outputs for each of it's properties. They will emit a signal when the property changes value when this or some other **Object** node with the same _Id_ triggers a set. |
<span className="hidden-props-for-editor"><##output:changed-\*##>Triggered when this user defined property is changed.<##output##></span>
<span className="hidden-props-for-editor">{/*##output:changed-\*##*/}Triggered when this user defined property is changed.{/*##output##*/}</span>
<span className="hidden-props-for-editor"><##input:prop-\*##>User defined property.<##input##></span>
<span className="hidden-props-for-editor">{/*##input:prop-\*##*/}User defined property.{/*##input##*/}</span>
<span className="hidden-props-for-editor"><##output:prop-\*##>User defined property.<##output##></span>
<span className="hidden-props-for-editor">{/*##output:prop-\*##*/}User defined property.{/*##output##*/}</span>

12
nodes/data/object/set-object-properties/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Set Object Properties node
---
<##head##>
{/*##head##*/}
# Set Object Properties
@@ -26,7 +26,7 @@ You can then specify which properties you want to set on the Object in the prope
Finally, send a signal to **Do** to perform the action.
<##head##>
{/*##head##*/}
## Inputs
@@ -35,18 +35,18 @@ Finally, send a signal to **Do** to perform the action.
| Data | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Id Source</span> | An Id of a record is needed to perform the action of this node. The **Id Source** property specifies how this Id is retrieved, the options are:<br/><br/>`Specify explicitly`: This means you need to specify the Id of the record explicitly through e.g. a connection to the **Id** input.<br/>`From repeater`: This means that the Id for the record will be derived from a repeater. This option is only valid if the component this node is placed in is created by a repeater. Then this node will act on the repeater object that this component was created for. |
| <span className="ndl-data">Id</span> | <##input:id##>On this input you provide the **Id** of the object where you will set the properties.<##input##> |
| <span className="ndl-data">Id</span> | {/*##input:id##*/}On this input you provide the **Id** of the object where you will set the properties.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | -------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal on this input to perform the action and set the properties.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal on this input to perform the action and set the properties.{/*##input##*/} |
## Outputs
| Data | Description |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the Object where you will / have set the properties. This is simply a mirror of the **Id** input.<##output##> |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the Object where you will / have set the properties. This is simply a mirror of the **Id** input.{/*##output##*/} |
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Done</span> | <##output:done##>A signal is sent on this output when the action is performed. You can use this to trigger other actions that needs to run after the properties have been set.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}A signal is sent on this output when the action is performed. You can use this to trigger other actions that needs to run after the properties have been set.{/*##output##*/} |

4
nodes/data/rest/README.md
View File

@@ -3,7 +3,7 @@ hide_title: true
title: REST node
---
<##head##>
{/*##head##*/}
# REST
@@ -17,7 +17,7 @@ This node is used to connect to external [REST](https://en.wikipedia.org/wiki/Re
You initiate the request by sending a <span className="ndl-signal">signal</span> to the <span className="ndl-signal">Fetch</span> input. Any inputs and outputs to the node are specified in the `request` and `response` scripts.
<##head##>
{/*##head##*/}
## Request and response script

4
nodes/data/run-tasks/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Run Tasks node
---
<##head##>
{/*##head##*/}
# Run Tasks
@@ -24,7 +24,7 @@ The <span className="ndl-node">Run Tasks</span> node needs a task component that
</div>
<##head##>
{/*##head##*/}
You can control the behaviour of how the tasks are run with the properties.

4
nodes/data/string/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: String node
---
<##head##>
{/*##head##*/}
# String
@@ -18,7 +18,7 @@ This node contains a <span className="ndl-data">string</span> value (text). It c
You can also use the String node connected to a <span className="ndl-node">Component Inputs</span> node. This will make sure the input shows up as a <span className="ndl-data">string</span> input in the Property Panel for instances of this component.
<##head##>
{/*##head##*/}
You can use it to provide a static value for input to other nodes. It is local to the component and cannot be accessed anywhere else in the graph.

16
nodes/data/user/log-in/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Log In node
---
<##head##>
{/*##head##*/}
# Log In
@@ -24,26 +24,26 @@ Once a user is logged in, their data can be accessed through the <span className
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ------------------------------------------ | --------------------------------------------------------------------------------- |
| <span className="ndl-data">Username</span> | <##input:username##>The username of the user that should be logged in.<##input##> |
| <span className="ndl-data">Password</span> | <##input:password##>The password of the user that should be logged in.<##input##> |
| <span className="ndl-data">Username</span> | {/*##input:username##*/}The username of the user that should be logged in.{/*##input##*/} |
| <span className="ndl-data">Password</span> | {/*##input:password##*/}The password of the user that should be logged in.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this action to log in the user. You need to make sure the **Username** and **Password** is connected, these will be sent to the backend for authentication.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this action to log in the user. You need to make sure the **Username** and **Password** is connected, these will be sent to the backend for authentication.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This event will be triggered if the log in was succesful.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event will be triggered if something went wrong while trying to log in the user. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the log in was succesful.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to log in the user. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the log in failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the log in failed.{/*##output##*/} |

12
nodes/data/user/log-out/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Log Out node
---
<##head##>
{/*##head##*/}
# Log Out
@@ -16,21 +16,21 @@ This node is used to log out a user from the current session. That means that th
</div>
<##head##>
{/*##head##*/}
## Inputs
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this action to logout the user. The user session will be removed from the browser.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this action to logout the user. The user session will be removed from the browser.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This event will be triggered if the logout was succesful.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event will be triggered if something went wrong while trying to logout the user. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the logout was succesful.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to logout the user. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the log out failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the log out failed.{/*##output##*/} |

16
nodes/data/user/set-user-properties/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Set User Properties node
---
<##head##>
{/*##head##*/}
# Set User Properties
@@ -17,26 +17,26 @@ This node is used to set properties on the currently logged in user.
</div>
A user needs to be logged in via either the <span className="ndl-node">Sign Up</span> node or the <span className="ndl-node">Log In</span> node. If you want to read user properties of the currently logged in user you can use the <span className="ndl-node">User</span> node.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Email</span> | <##input:email##>This input is used to set the **Email** property.<##input##> |
| <span className="ndl-data">Your custom properties</span> | <##input:prop-\*##>A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. <##input##> These will show up as inputs on the **Set User Properties** node. |
| <span className="ndl-data">Email</span> | {/*##input:email##*/}This input is used to set the **Email** property.{/*##input##*/} |
| <span className="ndl-data">Your custom properties</span> | {/*##input:prop-\*##*/}A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. {/*##input##*/} These will show up as inputs on the **Set User Properties** node. |
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this input to store the properties in the user record in the Noodl Cloud Services. Once completed the **Success** or **Failure** action will be triggered.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this input to store the properties in the user record in the Noodl Cloud Services. Once completed the **Success** or **Failure** action will be triggered.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This event will be triggered if the properties was succesfully stored.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This event will be triggered if something went wrong while trying to store the properties on the **User** record in the Noodl Cloud Services. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the properties was succesfully stored.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to store the properties on the **User** record in the Noodl Cloud Services. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the action failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the action failed.{/*##output##*/} |

20
nodes/data/user/sign-up/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Sign Up node
---
<##head##>
{/*##head##*/}
# Sign Up
@@ -24,28 +24,28 @@ The <span className="ndl-node">Sign Up</span> node is the easiest way to handle
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Username</span> | <##input:username##>This is the username of the new user that is going to sign up. It is required that this input has a value and it must be unique, or the sign up will fail.<##input##> |
| <span className="ndl-data">Password</span> | <##input:password##>This input should contain the password for the new user.<##input##> |
| <span className="ndl-data">Email</span> | <##input:email##>Optionally the new user can be given assigned an email.<##input##> |
| <span className="ndl-data">Your custom properties</span> | <##input:prop-\*##>A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. <##input##> These will show up as inputs on the **Sign Up** node to optionally bhe given a value during sign up. |
| <span className="ndl-data">Username</span> | {/*##input:username##*/}This is the username of the new user that is going to sign up. It is required that this input has a value and it must be unique, or the sign up will fail.{/*##input##*/} |
| <span className="ndl-data">Password</span> | {/*##input:password##*/}This input should contain the password for the new user.{/*##input##*/} |
| <span className="ndl-data">Email</span> | {/*##input:email##*/}Optionally the new user can be given assigned an email.{/*##input##*/} |
| <span className="ndl-data">Your custom properties</span> | {/*##input:prop-\*##*/}A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. {/*##input##*/} These will show up as inputs on the **Sign Up** node to optionally bhe given a value during sign up. |
| Signal | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Send a signal to this action to trigger the sign up. Once completed the **Success** or **Failure** event will be triggered.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this action to trigger the sign up. Once completed the **Success** or **Failure** event will be triggered.{/*##input##*/} |
## Outputs
| Signal | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>This action will be triggered if the sign up was succesful. The user is now logged in and information about the user can be accessed via the **User** node.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This action will be triggered if something went wrong while trying to sign up the user. The error message can be found in the **Error** output.<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This action will be triggered if the sign up was succesful. The user is now logged in and information about the user can be accessed via the **User** node.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This action will be triggered if something went wrong while trying to sign up the user. The error message can be found in the **Error** output.{/*##output##*/} |
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Error</span> | <##output:error##>This output will contain the error message if the sign up failed.<##output##> |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the sign up failed.{/*##output##*/} |

32
nodes/data/user/user-node/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: User node
---
<##head##>
{/*##head##*/}
# User
@@ -24,31 +24,31 @@ The <span className="ndl-node">User</span> node only works if the user is create
</div>
<##head##>
{/*##head##*/}
## Inputs
| Signal | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetch</span> | <##input:fetch##>Send a signal to this input to fetch the user properties for the current logged in user from the Noodl Cloud Services. There must be a valid user session for this to work.<##input##> |
| <span className="ndl-signal">Fetch</span> | {/*##input:fetch##*/}Send a signal to this input to fetch the user properties for the current logged in user from the Noodl Cloud Services. There must be a valid user session for this to work.{/*##input##*/} |
## Outputs
| Data | Description |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Id</span> | <##output:id##>The **Id** of the User record for the current logged in user.<##output##> |
| <span className="ndl-data">Username</span> | <##output:username##>The **Username** of the current logged in user.<##output##> |
| <span className="ndl-data">Email</span> | <##output:email##>The **Email** of the current logged in user, if the user has an email stored.<##output##> |
| <span className="ndl-data">Authenticated</span> | <##output:authenticated##>This output will be true if a valid user session exists in the browser, i.e. there is a logged in user.<##output##> |
| <span className="ndl-data">Error</span> | <##output:error##>If a **Fetch** action failed to retrieve the user information from the Noodl Cloud Services this output will contain the error message.<##output##> |
| <span className="ndl-data">Your custom properties</span> | <##output:prop-\*##>The value of extra properties of the **User** class specified in the Noodl Cloud Services.<##output##> The node will contain the latest value of all user properties. |
| <span className="ndl-data">Id</span> | {/*##output:id##*/}The **Id** of the User record for the current logged in user.{/*##output##*/} |
| <span className="ndl-data">Username</span> | {/*##output:username##*/}The **Username** of the current logged in user.{/*##output##*/} |
| <span className="ndl-data">Email</span> | {/*##output:email##*/}The **Email** of the current logged in user, if the user has an email stored.{/*##output##*/} |
| <span className="ndl-data">Authenticated</span> | {/*##output:authenticated##*/}This output will be true if a valid user session exists in the browser, i.e. there is a logged in user.{/*##output##*/} |
| <span className="ndl-data">Error</span> | {/*##output:error##*/}If a **Fetch** action failed to retrieve the user information from the Noodl Cloud Services this output will contain the error message.{/*##output##*/} |
| <span className="ndl-data">Your custom properties</span> | {/*##output:prop-\*##*/}The value of extra properties of the **User** class specified in the Noodl Cloud Services.{/*##output##*/} The node will contain the latest value of all user properties. |
| Signal | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>This signal is triggered after a **Fetch** has been successfully performed. That is the **Fetch** action is triggered by a signal and the user data is return from the Noodl Cloud Services.<##output##> |
| <span className="ndl-signal">Changed</span> | <##output:changed##>This signal is triggered when the User is changed locally by a **Set User Properties** node or a **Fetch** action of a **User** node.<##output##> |
| <span className="ndl-signal">Failure</span> | <##output:failure##>This signal is triggered when a **Fetch** action failed to retrieve the latest user data from the Noodl Cloud Services. This could be due to an invalid session.<##output##> |
| <span className="ndl-signal">Logged In</span> | <##output:logged in##>This signal is triggered when a user has been successfully logged in.<##output##> |
| <span className="ndl-signal">Logged Out</span> | <##output:logged out##>This signal is triggered when a user has been successfully logged out.<##output##> |
| <span className="ndl-signal">Session Lost</span> | <##output:session lost##>This signal is triggered when the current user session becomes invalid, e.g. if it has timed out.<##output##> |
| <span className="ndl-signal">Changed events</span> | <##output:changed-\*##>This signal will be triggered when the property is changed using the **Set User Property** node or when the latest user data is retrieved from the Noodl Cloud Services with the **Fetch** action.<##output##> |
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}This signal is triggered after a **Fetch** has been successfully performed. That is the **Fetch** action is triggered by a signal and the user data is return from the Noodl Cloud Services.{/*##output##*/} |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}This signal is triggered when the User is changed locally by a **Set User Properties** node or a **Fetch** action of a **User** node.{/*##output##*/} |
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This signal is triggered when a **Fetch** action failed to retrieve the latest user data from the Noodl Cloud Services. This could be due to an invalid session.{/*##output##*/} |
| <span className="ndl-signal">Logged In</span> | {/*##output:logged in##*/}This signal is triggered when a user has been successfully logged in.{/*##output##*/} |
| <span className="ndl-signal">Logged Out</span> | {/*##output:logged out##*/}This signal is triggered when a user has been successfully logged out.{/*##output##*/} |
| <span className="ndl-signal">Session Lost</span> | {/*##output:session lost##*/}This signal is triggered when the current user session becomes invalid, e.g. if it has timed out.{/*##output##*/} |
| <span className="ndl-signal">Changed events</span> | {/*##output:changed-\*##*/}This signal will be triggered when the property is changed using the **Set User Property** node or when the latest user data is retrieved from the Noodl Cloud Services with the **Fetch** action.{/*##output##*/} |

12
nodes/data/variable/set-variable/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Set Variable node
---
<##head##>
{/*##head##*/}
# Set Variable
@@ -16,21 +16,21 @@ This node sets the **Value** of a [Variable](/nodes/data/variable/variable-node)
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Name</span> | <##input:name##>The name of the **Variable** to set. Note: All **Variable** nodes with the same name will share the same data.<##input##> |
| <span className="ndl-data">Value</span> | <##input:value##>The value that you want the **Variable** to get when you trigger the <span className="ndl-signal">Do</span> action.<##input##> |
| <span className="ndl-data">Name</span> | {/*##input:name##*/}The name of the **Variable** to set. Note: All **Variable** nodes with the same name will share the same data.{/*##input##*/} |
| <span className="ndl-data">Value</span> | {/*##input:value##*/}The value that you want the **Variable** to get when you trigger the <span className="ndl-signal">Do</span> action.{/*##input##*/} |
| Signal | Description |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Do</span> | <##input:do##>Updates the value of the **Variable** to what is currently set on the input **Value**.<##input##> |
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Updates the value of the **Variable** to what is currently set on the input **Value**.{/*##input##*/} |
## Outputs
| Signal | Description |
| ---------------------------------------- | ----------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Done</span> | <##output:done##>This event is triggered when the **Variable** have been set.<##output##> |
| <span className="ndl-signal">Done</span> | {/*##output:done##*/}This event is triggered when the **Variable** have been set.{/*##output##*/} |

18
nodes/data/variable/variable-node/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Variable node
---
<##head##>
{/*##head##*/}
# Variable
@@ -18,7 +18,7 @@ Use this node to store a single data variable that will be globally accessible t
The value can be dynamically stored, either by passing it a new value or by sending <span className="ndl-signal">signals</span> to the <span className="ndl-node">[Set Variable](/nodes/data/variable/set-variable)</span> node.
<##head##>
{/*##head##*/}
## Storing a value
@@ -32,21 +32,21 @@ When a value is stored in a variable you can use it somewhere else in your appli
| Data | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Name</span> | <##input:name##>The name of the **Variable**. All **Variable** nodes with the same name will share the same data.<##input##> |
| <span className="ndl-data">Value</span> | <##input:value##>The value that you want the **Variable** to get. You will connect your data to this input. The value of the **Variable** will change when the data changes. If you want to control more precisely when the value should be updated, you should use the [Set Variable](/nodes/data/variable/set-variable) node.<##input##> |
| <span className="ndl-data">Name</span> | {/*##input:name##*/}The name of the **Variable**. All **Variable** nodes with the same name will share the same data.{/*##input##*/} |
| <span className="ndl-data">Value</span> | {/*##input:value##*/}The value that you want the **Variable** to get. You will connect your data to this input. The value of the **Variable** will change when the data changes. If you want to control more precisely when the value should be updated, you should use the [Set Variable](/nodes/data/variable/set-variable) node.{/*##input##*/} |
| Signal | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-signal">Fetch</span> | <##input:fetch##>Normally the value output of the node is updated once the **Name** input is set and if there is a change in the data from somewhere in the graph. However, if this signal has a connection it will wait until it gets a signal on **Fetch** before it updates.<##input##> |
| <span className="ndl-signal">Fetch</span> | {/*##input:fetch##*/}Normally the value output of the node is updated once the **Name** input is set and if there is a change in the data from somewhere in the graph. However, if this signal has a connection it will wait until it gets a signal on **Fetch** before it updates.{/*##input##*/} |
## Outputs
| Data | Description |
| --------------------------------------- | -------------------------------------------------------------------------- |
| <span className="ndl-data">Value</span> | <##output:value##>The current value of this **Variable** node.<##output##> |
| <span className="ndl-data">Name</span> | <##output:name##>The name of the **Variable**.<##output##> |
| <span className="ndl-data">Value</span> | {/*##output:value##*/}The current value of this **Variable** node.{/*##output##*/} |
| <span className="ndl-data">Name</span> | {/*##output:name##*/}The name of the **Variable**.{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Changed</span> | <##output:changed##>This signal is sent when the **Value** of this **Variable** has changed. Note: The signal triggers when any **Variable** with the same **Name** is changed, i.e. it triggers when the underlying data has changed.<##output##> |
| <span className="ndl-signal">Fetched</span> | <##output:fetched##>Signal when the data of this **Variable** node has been fetched and updated, either as a response to the **Fetch** input signal (when it has completed and the output **Value** is updated), or when the **Name** of the variable have changed.<##output##> |
| <span className="ndl-signal">Changed</span> | {/*##output:changed##*/}This signal is sent when the **Value** of this **Variable** has changed. Note: The signal triggers when any **Variable** with the same **Name** is changed, i.e. it triggers when the underlying data has changed.{/*##output##*/} |
| <span className="ndl-signal">Fetched</span> | {/*##output:fetched##*/}Signal when the data of this **Variable** node has been fetched and updated, either as a response to the **Fetch** input signal (when it has completed and the output **Value** is updated), or when the **Name** of the variable have changed.{/*##output##*/} |