h3_hexring函數

語法

h3_hexring（h3CellIdExpr，kExpr）

參數

• h3CellIdExpr: BIGINT表達式，或表示H3單元格ID的十六進製STRING表達式。

• kExpr:表示網格距離的INTEGER表達式。kExpr必須是非負的。

返回

對象的類型相同類型的值的ARRAYh3CellIdExpr表達式，對應於與輸入H3單元具有相同分辨率的H3單元id，在距離上形成以原點H3單元為中心的空心環k,在那裏k的值kExpr．

如果任何一個輸入表達式為NULL，則該函數返回NULL。該函數對輸入參數是否為有效的H3單元格ID進行部分驗證。一個有效H3 ID的必要但不是充分條件是它的值在0 x08001fffffffffff和0 x08ff3b6db6db6db6．如果輸入單元格ID不是有效的單元格ID，則函數的行為是未定義的。如果網格距離的值為零，則返回的數組包含一個等於輸入H3單元格ID的值。

錯誤條件

• 如果h3CellIdExpr是一個不能轉換為BIGINT或對應的BIGINT值小於0 x08001fffffffffff或者大於0 x08ff3b6db6db6db6，函數返回H3_INVALID_CELL_ID．

• 如果kExpr是負的，函數返回H3_INVALID_GRID_DISTANCE_VALUE．

• 如果有一個五邊形k-環的原始單元格，函數返回H3_PENTAGON_ENCOUNTERED_ERROR．

例子

簡單的例子，第一個參數是BIGINT。>選擇h3_hexring（599686042433355775，1）(599686014516068351，599686030622195711，599686044580839423，599686038138388479，599686043507097599，599686015589810175]簡單的例子，第一個參數是STRING。>選擇h3_hexring（“85283473 fffffff”，1）(8528340bfffffff，85283447fffffff，8528347bfffffff，85283463fffffff，85283477fffffff，8528340ffffffff]——第一個輸入是無效的H3單元ID。>選擇h3_hexring（0，0）(H3_INVALID_CELL_ID]0是不一個有效的H3細胞ID第二個輸入是一個無效的網格距離值。>選擇h3_hexring（“85283473 fffffff”，-1）(H3_INVALID_GRID_DISTANCE_VALUE]H3網格距離-1必須是非-負——輸入單元格是一個六邊形單元格與一個五邊形單元格相鄰(六邊形單元格的2環包含五邊形)。>選擇H3_HexRing（8007 fffffffffff，2）(H3_PENTAGON_ENCOUNTERED_ERROR]一個五角大樓是遇到而計算的十六進製環的8007 fffffffffff與網格距離2

相關功能

• h3_distance函數

• h3_kring函數

• h3_kringdistances函數