APIリファレンス(JavaScript)

baasatrakuza > DataQuery > headByLocation

DataQuery.headByLocation() method

オブジェクトデータを位置情報で検索して、最初の1件を返します。

Signature:

headByLocation(location?: RKZLocation, spotFieldName?: string): Promise<Data | null>;

Parameters

ParameterTypeDescription
locationRKZLocation検索対象の位置情報
spotFieldNamestringスポットオブジェクトを指定している項目名。

Returns:

Promise<Data | null>

オブジェクトデータまたはnull

Remarks

TIP

検索条件、ソート条件、取得範囲(offset, limit)を指定することができます。

WARNING

DataClient.getByLocation()と異なり、データが見つからない場合はnullを返します。