Get neighbors of an H3 index

Supported in: Batch, Streaming

Get all neighbors of an H3 index.

Expression categories: Geospatial

Declared arguments

  • Expression - A valid H3 index.
    Expression<H3 Index>

Output type: Array<H3 Index>

Examples

Example 1: Base case

Argument values:

  • Expression: h3Index
h3IndexOutput
8843a13687fffff[ 8843a13681fffff, 8843a13683fffff, 8843a13685fffff, 8843a136abfffff, 8843a136b9fffff, 8843a136bdfffff ]
85283473fffffff[ 8528340bfffffff, 8528340ffffffff, 85283447fffffff, 85283463fffffff, 85283477fffffff, 8528347bfffffff ]
860800007ffffff[ 860800017ffffff, 86080001fffffff, 860800027ffffff, 86080002fffffff, 860800037ffffff ]
Invalid h3 indexnull
nullnull