Appsemble 0.13.0
Getting Started
Guide
Architecture
Blocks
Action buttonButton listData loaderDetail viewerFeedFilterIntroductionActionsParametersEventsFormListMapMarkdownStatsTable
Development
Deployment
Reference
Remappers

Filter

Introduction

A block that can filter data and pass it to other blocks using the event API.

Actions

ActionRequiredDescription
onLoadtrueAction that gets dispatched when a new filter gets applied. This also gets called during the initial load.

Parameters

ParameterDefaultDescription
eventRequired field that determines the name of the event that other blocks can listen to to retrieve filtered data.
highlightThe field to highlight outside of the filter dialog. If set, changing the highlighted value will immediately apply a new filter
fieldsA list of objects describing each field that can be filtered
fields[].nameThe name used when storing this field
fields[].labelfield[].nameUser-facing label describing the field
fields[].typeThe type of the data
fields[].rangefalseWhether a range picker should be used
fields[].defaultValueThe default value used for the field. If not set, an empty filter option is added to allow for not filtering on this field at all
fields[].iconName of the Font Awesome icon to be displayed next to the label.
fields[].emptyLabelThe text to show for empty enum items.
fields[].enumA list of predetermined options the user can pick from.
fields[].enum[].labelUser-facing label describing the option
fields[].enum[].valueThe value that gets submitted when filtering

Events

Emit Events

EventDescription
dataThe event that is emitted when data is finished loading.