ol mapbox styleダウンロード-OL ol mapbox styleソースコードダウンロード

ol mapbox style

その他のソースコード

v12.3.5

ダウンロード

ol-mapboxスタイル

Mapboxスタイルの仕様オブジェクトからOpenLayersマップを作成します。

はじめる

ライブの例を探索することで、このライブラリが何をするかについての印象を得ます。

インストール

NPMベースの開発環境を備えたアプリケーションでライブラリを使用するには、

 npm install ol-mapbox-style

この方法でインストールしたら、以下の使用例のように、OL-Mapboxスタイルのモジュールをインポートするだけです。 OL-Mapboxスタイルのスタンドアロンビルドを使用するには、HTMLページに「DIST/OLMS.JS」を含めるだけで、グローバルolmsオブジェクトからエクスポートされた関数にアクセスします（ olms.apply() 、 olms.applyBackground() ）。スタンドアロンビルドは、OpenLayersの完全なビルドに依存することに注意してください。

ol-mapbox-style> = v9には、openlayersバージョン> = 7が必要です。

OL-Mapbox-StyleV8にはOpenLayersバージョンが必要> = 6.13.0 <7 。

使用法

完全なドキュメントについては、APIセクションを参照してください。

以下のコードは、 https:// urlを使用して、Mapboxの明るいV9スタイルからOpenLayersマップを作成します。

 import { apply } from 'ol-mapbox-style' ;

apply ( 'map' , 'https://api.mapbox.com/styles/v1/mapbox/bright-v9?access_token=YOUR_MAPBOX_TOKEN' ) ;

スタイルとソースをレイヤーのみに割り当てるには、 applyStyle()を使用します。 mapbox:// urlもサポートされています：

 import { applyStyle } from 'ol-mapbox-style' ;
import VectorTileLayer from 'ol/layer/VectorTile.js'

const layer = new VectorTileLayer ( { declutter : true } ) ;
applyStyle ( layer , 'mapbox://styles/mapbox/bright-v9' , { accessToken : 'YOUR_MAPBOX_TOKEN' } ) ;

マップボックススタイルのbackgroundレイヤーのプロパティをマップまたはVectorTileレイヤーに適用するには、 applyBackground()関数を使用します。

低レベルのAPIも利用できます。個々のOpenLayersベクターまたはベクトルタイルレイヤーのスタイル関数を作成するには、 stylefunctionモジュールを使用します。

 import { stylefunction } from 'ol-mapbox-style' ;
import VectorLayer from 'ol/layer/Vector.js' ;
import VectorSource from 'ol/source/Vector.js' ;
import GeoJSON from 'ol/format/GeoJSON.js' ;

const layer = new VectorLayer ( {
  source : new VectorSource ( {
    format : new GeoJSON ( ) ,
    url : 'data/states.geojson'
  } )
} ) ;

fetch ( 'data/states.json' ) . then ( function ( response ) {
  response . json ( ) . then ( function ( glStyle ) {
    stylefunction ( layer , glStyle , 'states' ) ;
  } ) ;
} ) ;

この低レベルAPIはレイヤーのソースを作成しないことに注意してください。また、アイコンを使用するスタイルのスプライトハンドリングをセットアップするには、追加の作業が必要であることに注意してください。

互換性メモ

フォント処理

ol-mapbox-styleマップボックススタイルの仕様で定義されているように、 text-fontレイアウトプロパティにPBF/SDFグリフを使用できません。代わりに、Webフォントに依存しています。 ol:webfonts metadataプロパティは、スタイルオブジェクトのルートに設定して、webfontsの場所を指定できます。

 {
  "version" : 8 ,
  "metadata" : {
    "ol:webfonts" : "https://my.server/fonts/{font-family}/{fontweight}{-fontstyle}.css"
  }
  // ...
}

別の方法として、 apply()またはapplyStyle()関数のwebfontsオプションを使用できます。

次のプレースホルダーは、テンプレートURLで使用できます。

{font-family} ：小文字に変換されたCSSフォントファミリ、ブランクが置き換えられました - 、例えばnoto-sans
{Font+Family} ：css fontファミリー元の場合、ブランクは+、たとえばnoto+sansに置き換えられました
{fontweight} ：css font weight（numeric）、たとえば400、700
{fontstyle} ：css fontスタイル、たとえば正常、イタリック体など
{-fontstyle} ：通常以外のcssフォントスタイル、例えば - イタリックまたは空の文字列

metadata['ol:webfonts']プロパティがStyleオブジェクトで使用できない場合、Fontsourceフォントが使用されます。また、アプリケーションがCSSを使用して他のフォントをロードすることも可能です。フォントがブラウザで既に利用可能である場合、 ol-mapbox-styleそれをロードしません。

この違いのため、フォントスタックは仕様で定義されているものとは少し異なります。スタイルと重量はプライマリフォント（つまり、フォントスタックの最初のもの）から取得されます。フォントスタック内の後続のフォントは、プライマリフォントが使用/読み込まれていない場合にのみ使用され、プライマリフォントのスタイルと重量で使用されます。

図書館の構築

 npm run build

結果の配布ファイルは、 dist/フォルダーにあります。ライブラリの動作を確認するには、 dist/index.htmlに移動します。

ローカルでテストを実行するには、実行します

 npm test

ブラウザでテストをデバッグするには、実行します

 npm run karma

コンソール出力（通常はhttp：// localhost：9876/）に示されているホストとポートにブラウザを開き、[デバッグ]ボタンをクリックしてデバッグ環境に移動します。

API

ol-mapbox-style • docs

<internal>

索引

インターフェイス

ApplyStyleOptions
featureidentifier
オプション
オプション

タイプエイリアス

ResourceType

ol-mapbox-style • docs

インターフェイス：ApplyStyleOptions

プロパティ

レイヤー

レイヤー： string []

レイヤー。ソースが提供されていない場合、提供されたIDのレイヤーがスタイルのlayersアレイから使用されます。すべてのレイヤーが同じソースを使用する必要があります。

ソース

出典： string

ソース。デフォルトは''で、スタイルの最初のソースが使用されます。

UpdatesSource

updatesource ： boolean

マップボックススタイルの定義でソースに指定されたパラメーターを使用して、ベクトル（タイル）レイヤーソースを更新または作成します。

ol-mapbox-style • docs

インターフェイス：featureidentifier

プロパティ

id

ID ： string | number

機能ID。

ソース

出典： string

ソースID。

ol-mapbox-style • docs

インターフェイス：オプション

プロパティ

AccessToken

AccessToken ： string

マップボックススタイルのアクセストークン。これはmapbox:// style urlsに提供する必要があります。 https://およびその他のURLの場合、アクセスキーはスタイルURLの最後のクエリパラメーターでなければなりません。

背景

背景： false | BackgroundColor

レイヤーの背景色。指定されていない場合、Mapbox Styleオブジェクトの背景が使用されます。 Mapboxスタイルの背景が使用されないようにfalseに設定します。

className

クラス名： string

レイヤー要素に設定するCSSクラス名。

整頓

Declutter ： boolean

整頓画像とテキスト。整頓は、これをtrue設定したすべてのベクトルおよびベクトル酸層のすべての画像およびテキストスタイルに適用されます。優先度は、レイヤーのZインデックス、スタイルのzIndex 、および機能のレンダリング順序によって定義されます。 Z-Indexが高いことは、優先度が高いことを意味します。同じz-index内で、別のZ-Indexの前にレンダリングされた機能は優先度が高くなります。

最適化として、同じclassNameを持つレイヤーから機能を整理して、Z-Indexに関係なく、これらすべてのレイヤーの塗りつぶしおよびストロークスタイルの上にレンダリングされます。この動作をオプトアウトし、独自のレイヤーでDeclutterd機能を配置するにはol-layer以外のclassNameでレイヤーを構成します。

範囲

範囲： Extent

レイヤーレンダリングの境界範囲。この範囲の外側にレイヤーはレンダリングされません。

レイヤー

レイヤー： string []

レンダリングを含むレイヤーのリストに制限します。すべてのレイヤーは、同じベクトルソースを共有する必要があります。スタイルが複数のソースを使用している場合、 sourceプロパティまたはlayersプロパティのいずれかを使用して、レンダリングを単一のベクトルソースに制限する必要があります。

地図

マップ： Map

マップ上のオーバーレイとしてレイヤーを設定します。マップはレイヤーコレクションのこのレイヤーを管理せず、レイヤーは上にレンダリングされます。これは一時的なレイヤーに役立ちます。マップにレイヤーを追加し、マップで管理する標準的な方法は、 map.addLayer()を使用することです。

上顎

上顎： number

このレイヤーが表示される最大解像度（排他的）。 maxResolutionやminZoomいずれも定義されていない場合、レイヤーのmaxResolutionスタイルソースのminzoomと一致します。

Maxzoom

Maxzoom ： number

このレイヤーが表示される最大ビューズームレベル（包括的）。

ミニソリューション

ミニソリューション： number

このレイヤーが表示される最小解像度（包括的）。

ミンズーム

Minzoom ： number

このレイヤーが表示される最小ビューズームレベル（排他的）。 maxResolutionやminZoomいずれも定義されていない場合、レイヤーのminZoomはスタイルソースのminzoomと一致します。

不透明

不透明度： number

不透明度（0、1）。

プリロード

プリロード： number

プリロード。低解像度タイルをpreloadレベルにロードします。 0プリロードがないことを意味します。

プロパティ

プロパティ： object

任意の観察可能なプロパティ。 #get()と#set()でアクセスできます。

renderbuffer

renderbuffer ： number

レンダリングまたはヒット検出のためにベクトルタイルから機能を取得するときに、レンダラーが使用するタイル範囲のピクセルのバッファー。推奨値：ベクトルタイルは通常、バッファーで生成されるため、この値は使用済みタイルの最大のバッファーと一致するはずです。少なくとも最大のポイントシンボルまたは線の幅のサイズでなければなりません。

rendermode

Rendermode ： VectorTileRenderType

ベクタータイルのレンダリングモード：

'hybrid' ：ポリゴンとライン要素は画像としてレンダリングされるため、ズームアニメーション中にピクセルが拡大されます。ポイントシンボルとテキストは、ベクトルとして正確にレンダリングされ、回転ビューで直立することができます。
'vector' ：すべてがベクトルとしてレンダリングされます。このモードを使用して、レンダリングされた機能が少ないベクトルタイルレイヤーのパフォーマンスを改善します（たとえば、同じソースを持つ別のレイヤーの特徴のサブセットを強調するため）。

renderorder

RenderOrder ： OrderFunction

注文をレンダリングします。レンダリングの前に機能をソートするときに使用する機能。デフォルトでは、それらが作成される順に描画されます。 null使用してソートを避けますが、未定義の描画順序を取得します。

ソース

出典： string

スタイルが複数のソースを使用している場合、 sourceプロパティまたはlayersプロパティのいずれかを使用して、レンダリングを単一のベクトルソースに制限する必要があります。 sourceプロパティは、マップボックススタイルのベクトルソースのIDに対応しています。

styleurl

styleurl ： string

このレイヤーに使用するマップボックススタイルオブジェクトのURL。 Mapbox Studioで作成され、Mapboxでホストされているスタイルの場合、これは「Mapbox：// Styles/You/Your-Style」のように見えます。

whileAnimatingを更新します

whileAnimatingを更新： boolean

trueに設定すると、機能バッチはアニメーション中に再作成されます。これは、ベクトルがクリップされないことを意味しますが、設定には大量のベクトルデータにパフォーマンスに影響があります。 falseに設定すると、アニメーションがアクティブでない場合、バッチは再作成されます。

相互作用の際に更新します

インターアクティブを更新する： boolean

trueに設定すると、フィーチャーバッチは相互作用中に再作成されます。 updateWhileAnimatingも参照してください。

useinterimtilesonerror

useinterimtilesonerror ： boolean

エラー時に暫定タイルを使用します。

見える

目に見える： boolean

可視性。

Zindex

Zindex ： number

レイヤーレンダリング用のZインデックス。レンダリング時に、最初にz-indexによって、次に位置によってレイヤーが注文されます。 undefinedの場合、マップのlayersコレクションに追加されるレイヤー、またはレイヤーのsetMap()メソッドが使用されたときにInfinityに0のzIndexが想定されます。

ol-mapbox-style • docs

インターフェイス：オプション

プロパティ

AccessToken

AccessToken ： string

'mapbox：//' urlsのトークンにアクセスします。

AccessTokenParam

AccessTokenParam ： string

アクセストークンパラメーション。内部使用のため。

getImage（）

getImage ：（ arg0 、 arg1 ）=> string | HTMLCanvasElement | HTMLImageElement

アイコン名の画像を返す関数。結果がHTMLIMAGEELEMENTである場合、すでにロードする必要があります。レイヤーは、画像の読み込みと処理が終了したときにlayer.changed（）を呼び出すために使用できます。この関数は、スプライトではなく、スプライトアイコンをオーバーライドするアイコンに使用されます。

パラメーター

• arg0 ： VectorLayer < VectorSource any 、 any > | VectorTileLayer < VectorTile any 、 any >

• arg1 ： string

返品

string | HTMLCanvasElement | HTMLImageElement

投影

投影： string

標準以外の予測で作業する場合にのみ便利です。 OpenLayersに登録された投影のコード。スタイルのすべてのソースは、この投影で提供する必要があります。また、投影には有効な範囲が定義されている必要があります。これは、スタイルのすべてのタイル張りのソースのタイルグリッドの起源と解像度を決定するために使用されます。提供されると、タイルおよびGeojson URLのBbox EPSG:4326ホルダーが変更されます。デフォルトは{bbox-epsg-4326} {bbox-epsg-3857}です。

解決策

解決策： number []

標準以外の予測で作業する場合にのみ便利です。マップボックススタイルで使用されるzoomへのマッピング解像度の解像度。

styleurl

styleurl ： string

マップボックスGLスタイルのURL。相対スプライトURLを含む場合、または相対URLによるデータを参照するソースを含む場合、オブジェクトとして提供されたスタイルに必要です。

transformrequest（）

TransformRequest ：（ arg0 、 arg1 ）=> string | void | Request | Promise < string | Request >

ol-mapbox-styleリソースをどのように取得するかを制御するための機能。 URLの変更、ヘッダーの追加、資格情報の設定オプションに使用できます。 URLとリソースタイプで引数として呼び出されたこの関数は、 RequestまたはURL文字string 、またはPromise tehereofを返すことになっています。返品値がないと、元のリクエストは変更されません。

パラメーター

• arg0 ： string

• Arg1 ： ResourceType

返品

string | void | Request | Promise < string | Request >

webfonts

WebFonts ： string

Webフォントを解決するためのテンプレート。 ol:webfontsメタデータがスタイルオブジェクトに設定されていない場合、Webフォントを取得する場所を指定するために使用できます。詳細については、 README.mdのgetFonts()および「フォント処理」セクションを参照してください。

ol-mapbox-style • docs

タイプエイリアス：ResourceType

ResourceType <>： "Style" | "Source" | "Sprite" | "SpriteImage" | "Tiles" | "GeoJSON"

タイプパラメーター

ol-mapbox-style • docs

ol-mapboxスタイル

モジュール

<internal>

クラス

MapboxVectorLayer

関数

addMapboxLayer
適用する
ApplyBackground
ApplyStyle
GetFeaturestate
GetLayer
GetLayers
getMapboxLayer
GetSource
GetStyleForLayer
RecordStylelayer
RemovemapboxLayer
render transparent
setfeaturestate
スタイル機能
updatemapboxlayer
updatemapboxsource

参照

デフォルト

改名と再輸出が適用されます

ol-mapbox-style • docs

クラス：MapBoxVectorLayer

classdesc

 import { MapboxVectorLayer } from 'ol-mapbox-style' ;

単一のベクトルソースを使用するマップボックススタイルに基づくベクトルタイル層。 Mapbox Studioの共有パネルに示されているstyleUrlとaccessTokenでレイヤーを構成します。スタイルが複数のソースを使用している場合、 sourceプロパティを使用して単一のベクトルソースを選択します。レイヤーのサブセットをスタイルでレンダリングする場合は、 layersプロパティを使用します（すべてのレイヤーが同じベクトルソースを共有する必要があります）。詳細については、コンストラクターオプションを参照してください。

 const map = new Map({
  view: new View({
    center: [0, 0],
    zoom: 1,
  }),
  layers: [
    new MapboxVectorLayer({
      styleUrl: 'mapbox://styles/mapbox/bright-v9',
      accessToken: 'your-mapbox-access-token-here',
    }),
  ],
  target: 'map',
});

構成または読み込みエラーで、レイヤーは'error'イベントをトリガーします。リスナーは、問題の診断に使用できるerrorプロパティを備えたオブジェクトを受け取ります。

メモフルビルドのユーザー： MapboxVectorLayerには、OLマップボックススタイルのライブラリもロードする必要があります。

パラメーション

オプション。

火

モジュール：OL/イベント/イベント〜BaseeVent＃イベント：エラー

API

拡張

VectorTileLayer

コンストラクター

新しいmapboxvectorlayer（）

新しいMapboxVectorLayer （ options ）： MapboxVectorLayer

パラメーター

•オプション： Options

レイヤーオプション。少なくとも、 styleUrlとaccessToken提供する必要があります。

返品

MapboxVectorLayer

オーバーライド

VectorTileLayer.constructor

プロパティ

AccessToken

AccessToken ： string

ol-mapbox-style • docs

機能：addmapboxlayer（）

addMapboxLayer （ mapOrGroup 、 mapboxLayer 、 beforeLayerId ？）： Promise void

スタイルに新しいマップボックスレイヤーオブジェクトを追加します。マップは再レンダリングされます。

パラメーター

• MaporGroup ： Map | LayerGroup

マップまたはレイヤーグループのapplyが呼び出されました。

• MapBoxLayer ： any

マップボックスレイヤーオブジェクト。

• beforeLayerid？ ： string

追加される新しいレイヤーの前のマップボックスレイヤーのオプションID。

返品

Promise void

追加されたレイヤーが使用可能な場合に解決します。

ol-mapbox-style • docs

関数：apply（）

apply （ mapOrGroupOrElement 、 style 、 options ）： Promise < Map | LayerGroup >

Mapbox StyleオブジェクトをOpenLayersマップまたはLayerGroupにロードして適用します。これには、マップの背景、レイヤー、およびマップインスタンスが含まれていますが、ビューはまだ定義されていませんが、中心とズームも含まれます。

例：

 import apply from 'ol-mapbox-style' ;

apply ( 'map' , 'mapbox://styles/mapbox/bright-v9' , { accessToken : 'YOUR_MAPBOX_TOKEN' } ) ;

中心とズームは、Mapboxスタイルのドキュメントに存在する場合にのみ設定され、OpenLayersマップにまだ設定されていない場合にのみ設定されます。

レイヤーは、すでにマップに設定されている可能性のあるレイヤーに影響を与えることなく、OpenLayersマップに追加されます。

apply()によって追加されたレイヤーには、2つの追加プロパティがあります。

mapbox-source ：OpenLayersレイヤーが作成されたというマップボックススタイルのドキュメントのソースのid 。通常、 apply()レイヤースタックには、その間の異なるソースからのレイヤーがある場合を除き、マップボックススタイルのソースごとに1つのOpenLayersレイヤーを作成します。
mapbox-layers ：OpenLayersレイヤーに含まれるMapbox Styleドキュメントのレイヤーのid s。

この関数は、Mapboxスタイルのオブジェクトを保持するOpenLayersマップまたはLayerGroupインスタンスに追加のmapbox-styleプロパティを設定します。

パラメーター

• maporgrouporelement ： string | Map | LayerGroup | HTMLElement

既存のOpenLayersマップインスタンス、またはHTML要素、または新しいOpenLayersマップのターゲットまたはレイヤーグループのターゲットとなるHTML要素のIDのいずれか。レイヤーグループの場合、スタイルはマップに触れ、ビューは無視されます。

•スタイル： any

JSONスタイルオブジェクトまたはマップボックススタイルのオブジェクトを指しているスタイルURL。 Mapbox APIを使用する場合、URLはMapbox Studioの「共有」パネルに示されているstyleUrlです。さらに、 accessTokenオプション（以下を参照）を設定する必要があります。 JSONスタイルのオブジェクトとして渡されると、 apply()によって作成されたすべてのOpenLayersレイヤーがすぐに利用可能になりますが、それらはまだソースを持っていない場合があります（つまり、Mapbox StyleドキュメントのTilejson URLによって定義されている場合）。スタイルURLとして渡されると、マップボックススタイルのドキュメントがロードされて解析されると、レイヤーがマップに追加されます。

•オプション： Options = {}

オプション。

返品

Promise < Map | LayerGroup >

すべてのレイヤーがOpenLayers Mapインスタンスまたはレイヤーグループに追加された後に解決される約束は、そのソースが設定され、スタイルが適用されました。 resolveコールバックは、OpenLayers Mapインスタンスまたはレイヤーグループで引数として呼び出されます。

ol-mapbox-style • docs

機能：ApplyBackground（）

ApplyBackground （ mapOrLayer 、 glStyle 、 options ）： Promise any

Mapbox Styleの最初のbackgroundレイヤーのプロパティを、提供されたマップまたはレイヤー（グループ）に適用します。

例：

 import { applyBackground } from 'ol-mapbox-style' ;
import { Map } from 'ol' ;

const map = new Map ( { target : 'map' } ) ;
applyBackground ( map , 'https://api.maptiler.com/maps/basic/style.json?key=YOUR_OPENMAPTILES_TOKEN' ) ;

パラメーター

• Maporlayer ： Map | BaseLayer

OpenLayersマップまたはレイヤー（グループ）。

• glstyle ： any

マップボックススタイルのオブジェクトまたはURL。

•オプション： Options = {}

オプション。

返品

Promise any

背景が適用されたときに解決する約束。

ol-mapbox-style • docs

関数：ApplyStyle（）

applystyle （ layer 、 glStyle 、 sourceOrLayersOrOptions ？、 optionsOrPath ？、 resolutions ？）： Promise any ）

ol/layer/VectorTileまたはOL ol/source/VectorTileまたはol/source/Vector ol/layer/Vectorにスタイル関数を適用します。レイヤーがまだソースを持っていない場合、 glStyleの情報から作成されて入力されます（ updateSourceがfalseに設定されていない限り）。

例：

 import { applyStyle } from 'ol-mapbox-style' ;
import { VectorTile } from 'ol/layer.js' ;

const layer = new VectorTile ( { declutter : true } ) ;
applyStyle ( layer , 'https://api.maptiler.com/maps/basic/style.json?key=YOUR_OPENMAPTILES_TOKEN' ) ;

スタイル関数は、最初のレイヤーのソース、指定されたsource 、または同じソースからのレイヤーのサブセットを使用するglStyleオブジェクトからすべてのレイヤーをレンダリングします。ソースは"type": "vector"または"type": "geojson"ソースである必要があります。

提供されたレイヤーに2つの追加プロパティが設定されます。

mapbox-source ：OpenLayersレイヤーが作成されたというマップボックススタイルのドキュメントのソースのid 。通常、 apply()レイヤースタックには、その間の異なるソースからのレイヤーがある場合を除き、マップボックススタイルのソースごとに1つのOpenLayersレイヤーを作成します。
mapbox-layers ：OpenLayersレイヤーに含まれるMapbox Styleドキュメントのレイヤーのid s。

パラメーター

•レイヤー： VectorLayer < VectorSource any 、 any > | VectorTileLayer < VectorTile any 、 any >

OpenLayersレイヤー。レイヤーにソースが構成されている場合、Glstyleのsourceから構成を使用するように変更されます。レイヤーのソースで指定されたオプションは、 urlとtileUrlFunctionを除き、Glstyleのsourceからのオプションをオーバーライドします。ソース投影がデフォルト（ EPSG:3857 ）の場合、 tileGridもオーバーライドされます。 ol-mapboxスタイルのソースを変更したくない場合は、 updateSource: falseオプションでapplyStyle()を構成します。

• glstyle ： any

マップボックススタイルのオブジェクト。

• sourceorerersoroptions？ ： string | string [] | Options ＆ ApplyStyleOptions = ''

Mapbox Styleオブジェクトからのオプションまたはsourceキーまたはレイヤーidの配列。 sourceキーが提供されると、指定されたソースのすべてのレイヤーがスタイル関数に含まれます。レイヤーidが提供される場合、それらは同じソースを使用するレイヤーからのものでなければなりません。提供されていない場合、またはFalsey値が提供されていない場合、Glstyleで指定された最初のソースを使用するすべてのレイヤーがレンダリングされます。

• optionsorpath？ ： string | Options ＆ ApplyStyleOptions = {}

非推奨。オプション。または、スタイルファイルのパス（スタイルの"sprite"プロパティに相対パスが使用される場合にのみ必要です）。

•解決策？ ： number [] = undefined

非推奨。解像度をマッピングするための解像度は、ズームレベルをズームします。標準以外のタイルグリッドまたはプロジェクションを使用するときにのみ必要な場合のみ、オプションを提供することもできます。

返品

Promise any

スタイルをレンダリングに使用できるときに解決される約束。

ol-mapbox-style • docs

関数：getFeaturestate（）

getFeaturestate （ mapOrLayer 、 feature ）： any

機能状態を設定または削除します。特徴状態は、機能のプロパティと同様に、スタイリングを考慮しており、選択した機能を異なる方法で条件付きにレンダリングするために使用できます。

パラメーター

• Maporlayer ： Map | VectorLayer < VectorSource any 、 any > | VectorTileLayer < VectorTile any 、 any >

機能状態をオンに設定するためのマップまたはレイヤー。

•機能： FeatureIdentifier

機能識別子。

返品

any

特徴状態またはnull指定された機能識別子に対して機能状態が設定されていない場合。

ol-mapbox-style • docs

関数：getLayer（）

getLayer （ map 、 layerId ）： Layer < Source 、 LayerRenderer < any >>

提供されたマップボックススタイルのlayer含むOpenLayersレイヤーインスタンスを取得します。複数のマップボックススタイルのレイヤーは、同じマップボックススタイルのsourceを使用するときに、単一のOpenLayersレイヤーインスタンスに組み合わされていることに注意してください。

パラメーター

•マップ： Map | LayerGroup

OpenLayersマップまたはレイヤーグループ。

•レイリド： string

マップボックススタイルのレイヤーID。

返品

Layer < Source 、 LayerRenderer < any >>

OpenLayersレイヤーインスタンス。

ol-mapbox-style • docs

関数：getLayers（）

getLayers （ map 、 sourceId ）： Layer < Source 、 LayerRenderer < any >> []

提供されたマップボックススタイルのsourceのOpenLayersレイヤーインスタンスを取得します。

パラメーター

•マップ： Map | LayerGroup

OpenLayersマップまたはレイヤーグループ。

• SourceID ： string

マップボックススタイルのソースID。

返品

Layer < Source 、 LayerRenderer < any >> []

OpenLayersレイヤーインスタンス。

ol-mapbox-style • docs

機能：getMapboxLayer（）

getMapboxLayer （ mapOrGroup 、 layerId ）： any

提供されたlayerIdのマップボックスレイヤーオブジェクトを取得します。

パラメーター

• MaporGroup ： Map | LayerGroup

マップまたはレイヤーグループ。

•レイリド： string

マップボックスレイヤーID。

返品

any

マップボックスレイヤーオブジェクト。

ol-mapbox-style • docs

関数：getSource（）

GetSource （ map 、 sourceId ）： Source

提供されたマップボックススタイルのsourceのOpenLayersソースインスタンスを取得します。

パラメーター

•マップ： Map | LayerGroup

OpenLayersマップまたはレイヤーグループ。

• SourceID ： string

マップボックススタイルのソースID。

返品

Source

OpenLayersソースインスタンス。

ol-mapbox-style • docs

機能：getStyleForLayer（）

getStyleforLayer （ feature 、 resolution 、 olLayer 、 layerId ）： Style []

特定のマップボックスレイヤーのみのスタイルを取得します。これは、伝説を作成するのに役立ちます。

パラメーター

•機能： RenderFeature | Feature Geometry

OpenLayers機能。

•解決策： number

解像度を表示します。

• Ollayer ： VectorLayer < VectorSource any 、 any > | VectorTileLayer < VectorTile any 、 any >

OpenLayersレイヤー。

•レイリド： string

マップボックスレイヤーのIDは、のスタイルを取得する

返品

Style []

提供されたマップボックスレイヤーのスタイル。

ol-mapbox-style • docs

機能：RecordStylElayer（）

RecordStylElayer （ record ）： void

マップボックススタイルのlayerの録音をオン /オフにします。オンにすると、レンダリングされた機能が属するレイヤーが機能のmapbox-layerプロパティとして設定されます。

パラメーター

•記録： boolean = false

スタイルレイヤーの記録がオンになっています。

返品

void

ol-mapbox-style • docs

機能：RemovemapboxLayer（）

RemovemapboxLayer （ mapOrGroup 、 mapboxLayerIdOrLayer ）： void

スタイルからマップボックスレイヤーオブジェクトを削除します。マップは再レンダリングされます。

パラメーター

• MaporGroup ： Map | LayerGroup

マップまたはレイヤーグループのapplyが呼び出されました。

• MapboxLayeridorlayer ： any

マップボックスレイヤーIDまたはマップボックスレイヤーオブジェクト。

返品

void

ol-mapbox-style • docs

関数：rendertransparent（）

rendertransparent （ enabled ）： void

透明なスタイルの機能をレンダリングするかどうかを構成します。 trueに設定すると、 ol/layer/Layer#getFeatures()またはol/Map#getFeaturesAtPixel()を使用して、ポリゴンの透明な塗りつぶしなど、見えないコンテンツを検出することが可能になります。

パラメーター

•有効化： boolean

透明な要素のレンダリングが有効になっています。デフォルトはfalseです。

返品

void

ol-mapbox-style • docs

関数：setfeaturestate（）

setfeaturestate （ mapOrLayer 、 feature 、 state ）： void

機能状態を設定または削除します。特徴状態は、機能のプロパティと同様に、スタイリングを考慮しており、選択した機能を異なる方法で条件付きにレンダリングするために使用できます。

特徴状態は、 mapbox-featurestateプロパティの特徴識別子と一致するOpenLayersレイヤーに保存されます。

パラメーター

• Maporlayer ： Map | VectorLayer < VectorSource any 、 any > | VectorTileLayer < VectorTile any 、 any >

OpenLayersマップまたはレイヤー機能状態を設定します。

•機能： FeatureIdentifier

機能識別子。

•状態： any

機能状態。機能状態を削除するためにnullに設定します。

返品

void

ol-mapbox-style • docs

関数：stylefunction（）

StyleFunction （ olLayer 、 glStyle 、 sourceOrLayers 、 resolutions 、 spriteData 、 spriteImageUrl 、 getFonts 、 getImage ？、... args ？）： StyleFunction

指定されたsourceを使用するすべてのレイヤーのglStyleオブジェクトからスタイル関数を作成します。これは、 "type": "vector"または"type": "geojson"ソースである必要があります。

提供されたレイヤーに2つの追加プロパティが設定されます。

mapbox-source ：OpenLayersレイヤーが作成されたというマップボックススタイルのドキュメントのソースのid 。通常、 apply()レイヤースタックには、その間の異なるソースからのレイヤーがある場合を除き、マップボックススタイルのソースごとに1つのOpenLayersレイヤーを作成します。
mapbox-layers ：OpenLayersレイヤーに含まれるMapbox Styleドキュメントのレイヤーのid s。

この機能は、Webワーカーでも機能します。ワーカーモードでは、メインスレッドはワーカーからのメッセージを聞き、別のメッセージで応答して、スプライト画像の読み込みが機能することを確認する必要があります。

 worker . addEventListener ( 'message' , event => {
  if ( event . data . action === 'loadImage' ) {
    const image = new Image ( ) ;
    image . crossOrigin = 'anonymous' ;
    image . addEventListener ( 'load' , function ( ) {
      createImageBitmap ( image , 0 , 0 , image . width , image . height ) . then ( imageBitmap => {
        worker . postMessage ( {
          action : 'imageLoaded' ,
          image : imageBitmap ,
          src : event . data . src
        } , [ imageBitmap ] ) ;
      } ) ;
    } ) ;
    image . src = event . data . src ;
  }
} ) ;

パラメーター

• Ollayer ： VectorLayer < VectorSource any 、 any > | VectorTileLayer < VectorTile any 、 any >

OpenLayersレイヤーにスタイルを適用します。スタイルに加えて、レイヤーは2つのプロパティを取得します。 mapbox-sourceレイヤーに使用されるglStyleのソースのidとなり、 mapbox-layers glStyleのレイヤーのidの配列です。

• glstyle ： any

マップボックススタイルのオブジェクト。

• sourceOrlayers ： string | string []

sourceキーまたはマップボックススタイルのオブジェクトからのレイヤーid sの配列。 sourceキーが提供されると、指定されたソースのすべてのレイヤーがスタイル関数に含まれます。レイヤーidが提供される場合、それらは同じソースを使用するレイヤーからのものでなければなりません。

•解像度： number [] = defaultResolutions

解像度をマッピングするための解像度は、ズームレベルをズームします。

• spritedata ： any = undefined

Mapbox Styleオブジェクトのspriteプロパティで指定されたURLからのスプライトデータ。 Mapboxスタイルのオブジェクトでspriteプロパティが指定されている場合にのみ必要です。

• spriteimageurl ： string | Request | Promise < string | Request > = undefined

マップボックススタイルオブジェクトのspriteプロパティで指定されたスプライト用のスプライト画像URL。 Mapboxスタイルのオブジェクトでspriteプロパティが指定されている場合にのみ必要です。

• getFonts = undefined

GLスタイルのmetadata['ol:webfonts']プロパティ（設定されている場合）からフォントスタックとURLテンプレートを受信し、利用可能な（変更された）フォントスタックを返します。フォント名は、マップボックススタイルのオブジェクトで使用される名前です。提供されていない場合、フォントスタックはそのまま使用されます。この関数は、Webフォントのロードにも使用できます。

• getImage？ = undefined

画像名の画像またはURLを返す関数。結果がHTMLIMAGEELEMENTである場合、すでにロードする必要があります。レイヤーは、画像の読み込みと処理が終了したときにlayer.changed（）を呼び出すために使用できます。この関数は、スプライトではないアイコンに使用するか、スプライトアイコンをオーバーライドすることができます。

•... args？ ： any