Function Reference
This page is a list of every function you can use to build components.
- The value of the cell at the given absolute path.
- The expression defined in the cell at the given absolute path.
- Returns a map of metadata (title, type, is starred, sync peers, error) for a datum.
- An array of accessible datum ids, filtered by an optional map of filters (CreatedByFilter, TypeFilter, FuzzyText, RootOnly, ValidOnly).
- Create an anchor to a specific node using a path.
- Logical AND.
- Reference a global application cell by name.
- The running sum of all of the numbers in an array.
- Returns true if the array contains the given element.
- Drop the last n elements from an array and return the remaining elements.
- Join two arrays together into a single array.
- The length of the array in elements.
- The maximum number in an array of numbers.
- The minimum number in an array of numbers.
- Insert an element at the end of an array.
- Remove an element at a given index from the array.
- Reverses the elements in the array.
- Set the value at the given index of an array.
- Returns the input array with the first n elements dropped.
- Sum of all numbers in an arrray.
- Take the first n elements from the array.
- Convert true to 1 and false to 0.
- Reference a cell by name.
- The absolute path of a cell in the evaluating component.
- Returns the value of a cell in a subcomponent.
- Get the absolute path of a cell in a subcomponent.
- Returns an array of the values of the cell defined by all current subcomponents.
- Brighten a color by some amount between 1 and -1.
- Saturate a color by some amount between -1 and 1.
- Compute a text layout with optional parameters {TextSize, LineHeight, MaxWidth}.
- Return an Array of {Start, End} Maps marking misspelled grapheme ranges in the given text.
- Gets the current value of a datum.
- Returns true when both argument expressions match. Does not evaluate the arguments.
- Evaluate an expression using the context of the evaluating node.
- Evaluate an expression using in context of its source.
- Evaluates each expression in the container, then evaluates views.
- Evaluate each expression in a container. Returns the same container, but each value is the result from evaluating.
- The number of matcher pairs in the given event handler.
- Get the type of some expression.
- Extend a node path to a child node.
- Get the path of a child node of the given node path.
- Use some filter text to search for matches in an Array of Text.
- Return the first {Start, End} range containing the integer index.
- Fuzzy filter an Array of Text by a search pattern. Results sorted by match quality.
- Retrieve a cursor position by name.
- Convert a text character into a shape.
- If the condition is true then return the second argument; otherwise, return the third argument.
- Get the value at the given index from the array.
- Returns true when a > b.
- True when the cursor is hovered over the node.
- Returns true if the view is mutable.
- Returns true when the number is an integer (not a fraction).
- Returns true when a < b.
- Returns true if the given expression can be evaluated successfully.
- Get the character index at a relative (x, y) point in a text layout.
- Get the maximum row width across all rows in a text layout.
- Get the position and width of a character at a given index in a text layout.
- Get the number of visual rows in a text layout (including soft-wrapped lines).
- Create a new map using the provided key and value.
- Apply a one-argument function to an array of values.
- Apply a two-argument function to an array of values using the supplied value as the first argument.
- Create a map by zipping a list of keys with list of values.
- Insert the value into the map at the given key.
- Return the key associated to a given index of a map.
- An array of all of the keys in the a map.
- List the keys and values of a map.
- Get the styling marks which apply to a given character in some text.
- Evaluate and return the expression at a given key in a map.
- The data associated with the currently matched event.
- Returns the larger value of a or b.
- Returns the smaller value of a or b.
- Produce a modification that sets a ComponentAction cell.
- Produce a modification that inserts a value into an Array cell at an index.
- Produce a modification that pushes a value onto an Array cell.
- Produce a modification that removes an element from an Array cell by index.
- Produce a modification that sets an element in an Array cell at an index.
- Produce a modification that sets a Bool cell.
- Produce a modification that sets a MatchableButtonStateChange cell.
- Produce a modification that removes a key from a CellMap cell.
- Produce a modification that sets a definition in a CellMap cell.
- Produce a modification that replaces a cell with a Color value.
- Produce a modification that sets a DatumId cell.
- Produce a modification that inserts a MatchOn pair into an EventHandler cell.
- Produce a modification that removes a pair from an EventHandler cell by index.
- Produce a modification that sets a FixPoint cell.
- Replace a function while preserving type-compatible arguments from the current expression.
- Produce a modification that replaces a cell with a function value.
- Produce a modification that sets a MatchableKeyboardKey cell.
- Produce a modification that removes a key from a Map cell.
- Produce a modification that sets a key in a Map cell.
- Produce a modification that sets a MatchOn cell.
- Produce a modification that sets a MatchableMouseButton cell.
- Produce a modification that sets a Number cell.
- Produce a modification that replaces a cell with an arbitrary value.
- Produce a modification that inserts an action into a RespondWith cell at an index.
- Produce a modification that removes an action from a RespondWith cell by index.
- Produce a modification that inserts an inline component into a Text cell.
- Produce a modification that splices a Text cell.
- Produce a modification that toggles a mark on a range of a Text cell.
- Produce a modification that sets the DatumId of a View cell.
- Produce a modification that appends a view block to a Workspace cell.
- Produce a modification that removes a view block from a Workspace cell by index.
- Negate a number.
- Create a sub-index literal using a type and and the expected arguments.
- The CellMap which defines the node.
- Information about the cells defined on a node.
- Get information about the subcomponents of a node.
- The view generating a node in the UI.
- The length (depth) of the node path.
- The array of Views blocks.
- The number of blocks in the note.
- Logical OR.
- List the cells in the component which are marked as overrideable.
- Reference a cell in a parent component by name.
- Get the absolute path of a cell in a parent component.
- Get the parent path of a given node path.
- Get the size of the angle in radians.
- True when the integer index lies in [range.Start, range.End).
- Repeats some value some number of times. Does not evaluate to_repeat.
- Repeats the given text a number of times.
- The height of the screen.
- The width of the screen.
- Return up to 3 spelling suggestions for the word in text at the given {Start, End} grapheme range.
- Join two texts together into a single text.
- The length of the text in characters.
- Convert text into a displayable shape.
- Returns the input text with the first n characters dropped.
- Split the text using the specified pattern.
- Take the first n characters from some text.
- Get the absolute path of the evaluating node.
- Convert a fractional number into an integer.
- Convert an expression into a short readable display.
- Performs a matrix transpose operation on an array of arrays.
- Try returning the result from the expression. If that fails then return the default value.
- Creates a view from a component doc and a set of overrides.
- The id of the component datum being referenced.
- The overrides set in the view.
- Sets cells on a component. Sets overrides on a View.
- Get the start and end grapheme indices of the word at the given index.