Class: Rectangle
地図上に描画される軸並行の矩形です。
一般的な地図 SDK の矩形(Rectangle)コンポーネントに相当します。バウンディングボックス 表示、範囲選択 UI、地理的な範囲のハイライトなどに使用します。
内部的には Polygon と同様に MapLibre の GeoJSON fill/line
ソース・レイヤーを利用し、bounds の 4 隅から矩形の頂点を導出します。
Example
const rectangle = new geolonia.maps.Rectangle({
bounds: {
north: 35.7,
south: 35.6,
east: 139.8,
west: 139.7,
},
map,
strokeColor: "#ff0000",
strokeWeight: 2,
fillColor: "#ff0000",
fillOpacity: 0.35,
});
rectangle.setBounds({
north: 36.0, south: 35.0, east: 140.0, west: 139.0,
});
Extends
Constructors
Constructor
new Rectangle(
options?):Rectangle
矩形を作成します。
Parameters
options?
初期の範囲、地図、描画スタイルです。bounds と map
の両方が指定された場合、矩形はすぐに表示されます。
Returns
Rectangle
Overrides
Methods
addListener()
addListener(
eventName,handler):MapsEventListener
指定した名前のイベントが発火するたびに実行されるハンドラを登録します。
Parameters
eventName
string
監視するイベント。"click" や "{property}_changed"
イベントなどです。
handler
イベントが発火するたびに、そのイベントの引数とともに呼び出されます。
Returns
MapsEventListener ハンドル。登録を解除するには remove() を
呼び出します。
Inherited from
bindTo()
bindTo(
key,target,targetKey,noNotify?):void
このオブジェクトの key プロパティを、別のオブジェクトの targetKey
プロパティにバインドします。これにより、key を読み取ると常にターゲットの値が
反映され、ターゲットが変化するたびに {key}_changed イベントが発火します。
Parameters
key
string
このオブジェクト上のプロパティ名。
target
バインド先のオブジェクト。
targetKey
string
ターゲット上のプロパティ名。
noNotify?
boolean = false
true の場合、初回およびそれ以降の {key}_changed
通知を抑制します。
Returns
void
Inherited from
get()
get(
key):any
名前付きプロパティの値を返します。一度も設定されていない場合は undefined
を返します。
Parameters
key
string
プロパティ名。
Returns
any
Inherited from
getBounds()
getBounds():
LatLngBounds|null
矩形の地理的範囲を返します。範囲が設定されていない場合は null を返します。
Returns
LatLngBounds | null
getMap()
getMap():
Map|null
この矩形が追加されている地図を返します。取り外された状態の場合は null を返します。
Returns
Map | null
getVisible()
getVisible():
boolean
矩形の可視性を返します。
Returns
boolean
notify()
notify(
key):void
プロパティの {key}_changed イベントを手動で発火し、そのすべてのリスナーに
通知します。値が set で再代入されるのではなく、その場で
変更された場合に役立ちます。
Parameters
key
string
プロパティ名。
Returns
void
Inherited from
set()
set(
key,value):void
名前付きプロパティを設定し、その {key}_changed イベントを発火します。
bindTo でバインドされた値を置き換える場合は、
先にバインディングを削除します。
Parameters
key
string
プロパティ名。
value
any
新しい値。
Returns
void
Inherited from
setBounds()
setBounds(
bounds):void
矩形の地理的範囲を設定します。
Parameters
bounds
LatLngBoundsLiteralOrLatLngBounds
新しい範囲です。LatLngBounds または LatLngBoundsLiteral を受け付けます。
Returns
void
setMap()
setMap(
map):void
矩形を地図に追加します。null を渡すと、現在の地図から取り外します。
Parameters
map
Map | null
矩形を描画する地図、または取り外す場合は null です。
Returns
void
setOptions()
setOptions(
options):void
複数のオプションをまとめて更新します。
Parameters
options
更新するオプションです。指定されていないものは変更されません。
Returns
void
setValues()
setValues(
values):void
複数の名前付きプロパティを一度に設定し、それぞれについて {key}_changed
イベントを発火します。
Parameters
values
Record<string, any>
キーがプロパティ名であるオブジェクト。
Returns
void
Inherited from
setVisible()
setVisible(
visible):void
矩形の可視性を設定します。
Parameters
visible
boolean
true で表示、false で非表示になります。
Returns
void
unbind()
unbind(
key):void
key のバインディングを削除し、最後に同期された値を通常のプロパティとして
保持します。
Parameters
key
string
解放するバインド済みのプロパティ名。
Returns
void
Inherited from
unbindAll()
unbindAll():
void
このオブジェクト上のすべてのバインディングを削除します。
Returns
void