SymbolLayerOptions interface
SymbolLayer でジオメトリをレンダリングするときに使用されるオプション。
- Extends
プロパティ
icon |
シンボルのアイコンをカスタマイズするために使用するオプション。 既定値については、「IconOptions」を参照してください。 |
line |
線に沿った 2 つのシンボル アンカー間の距離 (ピクセル単位)。 1 以上である必要があります。
既定値は |
placement | ジオメトリに対するラベルの配置を指定します。 '"point"': ラベルはジオメトリが配置されているポイントに配置されます。 '"line"': ラベルはジオメトリの線に沿って配置されます。 LineString ジオメトリと Polygon ジオメトリでのみ使用できます。 '"line-center"': ラベルはジオメトリの線の中心に配置されます。 'LineString' ジオメトリと 'Polygon' ジオメトリでのみ使用できます 既定の '"point"'。 |
sort |
この値に基づいて、特徴を昇順で並べ替えます。 下位の並べ替えキーを持つフィーチャが描画され、最初に配置されます。
既定値は |
source | レイヤーがレンダリングするデータ ソースの ID またはインスタンス。 |
source |
レイヤーのソースが VectorTileSource の場合に必要です。 ベクター ソースには複数のレイヤーを含めることができます。これにより、このレイヤーでレンダリングするレイヤーが識別されます。 他のすべての種類のソースでは禁止されています。 |
text |
記号のテキストをカスタマイズするために使用するオプション。 既定値については、「TextOptions」を参照してください。 |
z |
同じレイヤー内の重複するシンボルを、データ ソースに表示される順序でレンダリングするか、ビューポートに対する相対的な y 位置でレンダリングするかを指定します。
それ以外の場合は、シンボルの順序と優先順位を制御するには、 を使用 '"auto"': 設定されている場合は、'sortKey' でシンボルを並べ替えます。 それ以外の場合は、'"viewport-y"' のように動作します。 '"viewport-y"': 'allowOverlap' が 'true' の場合、または 'ignorePlacement' が 'false' の場合、シンボルを y 位置で並べ替えます。 '"source"': 設定されている場合は、'sortKey' でシンボルを並べ替えます。 それ以外の場合、シンボルはソース データと同じ順序でレンダリングされます。 既定の '"auto"' |
継承されたプロパティ
filter | ソース フィーチャの条件を指定する式。 フィルターに一致する機能のみが表示されます。 |
max |
レイヤーをレンダリングする最大ズーム レベルを指定する整数。
この値は排他的です。つまり、レイヤーは で |
min |
レイヤーをレンダリングする最小ズーム レベルを指定する整数。
この値は包括的です。つまり、レイヤーは で |
visible | レイヤーが表示されるかどうかを指定します。
既定値は |
プロパティの詳細
iconOptions
シンボルのアイコンをカスタマイズするために使用するオプション。
既定値については、「IconOptions」を参照してください。
iconOptions?: IconOptions
プロパティ値
lineSpacing
線に沿った 2 つのシンボル アンカー間の距離 (ピクセル単位)。 1 以上である必要があります。
既定値は 250
です。
lineSpacing?: number | PropertyValueSpecification<number>
プロパティ値
number | PropertyValueSpecification<number>
placement
ジオメトリに対するラベルの配置を指定します。
'"point"': ラベルはジオメトリが配置されているポイントに配置されます。
'"line"': ラベルはジオメトリの線に沿って配置されます。 LineString ジオメトリと Polygon ジオメトリでのみ使用できます。
'"line-center"': ラベルはジオメトリの線の中心に配置されます。 'LineString' ジオメトリと 'Polygon' ジオメトリでのみ使用できます
既定の '"point"'。placement?: "point" | "line" | "line-center"
プロパティ値
"point" | "line" | "line-center"
sortKey
この値に基づいて、特徴を昇順で並べ替えます。 下位の並べ替えキーを持つフィーチャが描画され、最初に配置されます。
既定値は undefined
です。
sortKey?: number | DataDrivenPropertyValueSpecification<number>
プロパティ値
number | DataDrivenPropertyValueSpecification<number>
source
sourceLayer
レイヤーのソースが VectorTileSource の場合に必要です。 ベクター ソースには複数のレイヤーを含めることができます。これにより、このレイヤーでレンダリングするレイヤーが識別されます。 他のすべての種類のソースでは禁止されています。
sourceLayer?: string
プロパティ値
string
textOptions
記号のテキストをカスタマイズするために使用するオプション。
既定値については、「TextOptions」を参照してください。
textOptions?: TextOptions
プロパティ値
zOrder
同じレイヤー内の重複するシンボルを、データ ソースに表示される順序でレンダリングするか、ビューポートに対する相対的な y 位置でレンダリングするかを指定します。
それ以外の場合は、シンボルの順序と優先順位を制御するには、 を使用 sortKey
します。
'"auto"': 設定されている場合は、'sortKey' でシンボルを並べ替えます。 それ以外の場合は、'"viewport-y"' のように動作します。
'"viewport-y"': 'allowOverlap' が 'true' の場合、または 'ignorePlacement' が 'false' の場合、シンボルを y 位置で並べ替えます。
'"source"': 設定されている場合は、'sortKey' でシンボルを並べ替えます。 それ以外の場合、シンボルはソース データと同じ順序でレンダリングされます。 既定の '"auto"'
zOrder?: "auto" | "viewport-y" | "source"
プロパティ値
"auto" | "viewport-y" | "source"
継承されたプロパティの詳細
filter
ソース フィーチャの条件を指定する式。 フィルターに一致する機能のみが表示されます。
filter?: Expression
プロパティ値
maxZoom
レイヤーをレンダリングする最大ズーム レベルを指定する整数。
この値は排他的です。つまり、レイヤーは で maxZoom > zoom >= minZoom
表示されます。
既定値は 24
です。
maxZoom?: number
プロパティ値
number
minZoom
レイヤーをレンダリングする最小ズーム レベルを指定する整数。
この値は包括的です。つまり、レイヤーは で maxZoom > zoom >= minZoom
表示されます。
既定値は 0
です。
minZoom?: number
プロパティ値
number