addFilter()

Last updated 18/03/2026

Definition

addFilter()

is a function on the

Five

object that adds a key and its value to the Five filter stack. Once a key is on the stack, any form whose data source contains a foreign key to that key will automatically be filtered by the value you provided across every drill-down level that follows. It is used when you need to push an extra key onto the stack beyond what Five adds automatically as you navigate.

Available: Client and server

Function Signature

addFilter(keyName: string, key: string) : void;

Parameter	Type	Description
keyName	string	The fully qualified primary key as a string
key	string	The value to filter by as a string

Return Value

This function does not have a return value.

Examples

addFilter()