GeoVerse

Appearance

Documentation / @geoverse/core-ol / GVectorLayerOptions

Interface: GVectorLayerOptions ​

Defined in: packages/core-ol/src/layers/vectorLayer.ts:7

Extends ​

  • Options<Feature, VectorSource>

Properties ​

background? ​

ts
optional background?: BackgroundColor;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:92

Background color for the layer. If not specified, no background will be rendered.

Inherited from ​

ts
Options.background

className? ​

ts
optional className?: string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:10

A CSS class name to set to the layer element.

Inherited from ​

ts
Options.className

declutter? ​

ts
optional declutter?: string | number | boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:81

Declutter images and text. Any truthy value will enable decluttering. Within a layer, a feature rendered before another has higher priority. All layers with the same declutter value will be decluttered together. The priority is determined by the drawing order of the layers with the same declutter value. Higher in the layer stack means higher priority. To declutter distinct layers or groups of layers separately, use different truthy values for declutter.

Inherited from ​

ts
Options.declutter

extent? ​

ts
optional extent?: Extent;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:23

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

Inherited from ​

ts
Options.extent

flatStyle? ​

ts
optional flatStyle?: FlatStyleLike;

Defined in: packages/core-ol/src/layers/vectorLayer.ts:12

声明式 FlatStyle（纯数据 JSON）。ol 矢量图层原生接受 FlatStyle， 便于序列化与作为 React/Vue 组件 prop 传入；与 style 二选一。

map? ​

ts
optional map?: Map;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:73

Sets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use [map.addLayer()]import ("../Map.js").default#addLayer.

Inherited from ​

ts
Options.map

maxResolution? ​

ts
optional maxResolution?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:40

The maximum resolution (exclusive) below which this layer will be visible.

Inherited from ​

ts
Options.maxResolution

maxZoom? ​

ts
optional maxZoom?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:50

The maximum view zoom level (inclusive) at which this layer will be visible.

Inherited from ​

ts
Options.maxZoom

minResolution? ​

ts
optional minResolution?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:35

The minimum resolution (inclusive) at which this layer will be visible.

Inherited from ​

ts
Options.minResolution

minZoom? ​

ts
optional minZoom?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:45

The minimum view zoom level (exclusive) above which this layer will be visible.

Inherited from ​

ts
Options.minZoom

opacity? ​

ts
optional opacity?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:14

Opacity (0, 1).

Inherited from ​

ts
Options.opacity

properties? ​

ts
optional properties?: {
[x: string]: any;
};

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:108

Arbitrary observable properties. Can be accessed with #get() and #set().

Index Signature ​

ts
[x: string]: any

Inherited from ​

ts
Options.properties

renderBuffer? ​

ts
optional renderBuffer?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:62

The buffer in pixels around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. Recommended value: the size of the largest symbol, line width or label.

Inherited from ​

ts
Options.renderBuffer

renderOrder? ​

ts
optional renderOrder?: OrderFunction;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:56

Render order. Function to be used when sorting features before rendering. By default features are drawn in the order that they are created. Use null to avoid the sort, but get an undefined draw order.

Inherited from ​

ts
Options.renderOrder

source? ​

ts
optional source?: VectorSource<Feature<Geometry, {
[x: string]: any;
}>>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:66

Source.

Inherited from ​

ts
Options.source

style? ​

ts
optional style?: StyleLike | FlatStyleLike | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:87

Layer style. When set to null, only features that have their own style will be rendered. See module :ol/style/Style~Style for the default style which will be used if this is not set.

Inherited from ​

ts
Options.style

updateWhileAnimating? ​

ts
optional updateWhileAnimating?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:99

When set to true, feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to false, batches will be recreated when no animation is active.

Inherited from ​

ts
Options.updateWhileAnimating

updateWhileInteracting? ​

ts
optional updateWhileInteracting?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:104

When set to true, feature batches will be recreated during interactions. See also updateWhileAnimating.

Inherited from ​

ts
Options.updateWhileInteracting

visible? ​

ts
optional visible?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:18

Visibility.

Inherited from ​

ts
Options.visible

zIndex? ​

ts
optional zIndex?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/layer/BaseVector.d.ts:30

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used.

Inherited from ​

ts
Options.zIndex