Documentation / @geoverse/core-ol / MassSource

Class: MassSource

Defined in: packages/core-ol/src/layers/massLayer.ts:160

海量点数据源（ImageCanvas）。 GMap.forEachSmFeatureAtPixel 依赖本类的 _forEachFeatureAtCoordinate 方法。

Extends

• ImageCanvasSource

Constructors

Constructor

new MassSource(options?): MassSource;

Defined in: packages/core-ol/src/layers/massLayer.ts:168

Parameters

options?

MassSourceOptions = {}

Returns

MassSource

Overrides

ImageCanvas.constructor

Properties

defaultStyle

readonly defaultStyle: Style;

Defined in: packages/core-ol/src/layers/massLayer.ts:163

---

disposed

protected disposed: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Disposable.d.ts:15

The object has already been disposed.

Inherited from

ImageCanvas.disposed

---

graphics

graphics: Graphic[] = [];

Defined in: packages/core-ol/src/layers/massLayer.ts:162

---

image

protected image: ImageWrapper;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:149

Inherited from

ImageCanvas.image

---

loader

protected loader: Loader;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:129

Inherited from

ImageCanvas.loader

---

loading

loading: number | boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:114

This source is currently loading data. Sources that defer loading to the map's tile queue never set this to a truthy value.

Inherited from

ImageCanvas.loading

---

map?

optional map?: Map;

Defined in: packages/core-ol/src/layers/massLayer.ts:161

---

on

on: ImageSourceOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:116

Inherited from

ImageCanvas.on

---

once

once: ImageSourceOnSignature<EventsKey>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:120

Inherited from

ImageCanvas.once

---

projection

protected projection: Projection | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:98

Inherited from

ImageCanvas.projection

---

un

un: ImageSourceOnSignature<void>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:124

Inherited from

ImageCanvas.un

---

viewRejector

protected viewRejector: (arg0) => void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:139

Parameters

arg0

Error

Returns

void

Inherited from

ImageCanvas.viewRejector

---

viewResolver

protected viewResolver: (arg0) => void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:134

Parameters

arg0

ViewOptions

Returns

void

Inherited from

ImageCanvas.viewResolver

Methods

_forEachFeatureAtCoordinate()

_forEachFeatureAtCoordinate(
   currentExtent, 
   coord, 
   resolution, 
   callback, 
   pixel, 
   event?): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:326

命中检测（保持旧库鸭子类型协议，GMap.forEachSmFeatureAtPixel 会调用）。

Parameters

currentExtent

Extent

coord

Coordinate

resolution

number

callback

GraphicHitCallback

pixel

number[]

event?

unknown

Returns

void

---

addChangeListener()

addChangeListener(key, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:145

Parameters

key

string

Key name.

listener

Listener

Listener.

Returns

void

Inherited from

ImageCanvas.addChangeListener

---

addEventListener()

addEventListener(type, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:50

Parameters

type

string

Type.

listener

Listener

Listener.

Returns

void

Inherited from

ImageCanvas.addEventListener

---

addGraphics()

addGraphics(graphics): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:247

追加 graphics（仅对新增项做投影转换——修复旧库重复投影 bug）

Parameters

graphics

Graphic | Graphic[]

Returns

void

---

applyProperties()

protected applyProperties(source): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:172

Apply any properties from another object without triggering events.

Parameters

source

BaseObject

The source object.

Returns

void

Inherited from

ImageCanvas.applyProperties

---

changed()

changed(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:65

Increases the revision counter and dispatches a 'change' event.

Returns

void

Api

Inherited from

ImageCanvas.changed

---

clear()

clear(): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:287

Returns

void

---

destroy()

destroy(): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:220

解绑本数据源注册的地图监听与渲染器

Returns

void

---

dispatchEvent()

dispatchEvent(event): boolean | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:61

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Parameters

event

string | BaseEvent

Event object.

Returns

boolean | undefined

false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api

Inherited from

ImageCanvas.dispatchEvent

---

dispose()

dispose(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Disposable.d.ts:19

Clean up.

Returns

void

Inherited from

ImageCanvas.dispose

---

disposeInternal()

protected disposeInternal(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Disposable.d.ts:24

Extension point for disposable objects.

Returns

void

Inherited from

ImageCanvas.disposeInternal

---

findNearestResolution()

protected findNearestResolution(resolution): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:184

Parameters

resolution

number

Resolution.

Returns

number

Resolution.

Inherited from

ImageCanvas.findNearestResolution

---

get()

get(key): any;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:114

Gets a value.

Parameters

key

string

Key name.

Returns

any

Value.

Api

Inherited from

ImageCanvas.get

---

getAttributions()

getAttributions(): Attribution | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:150

Get the attribution function for the source.

Returns

Attribution | null

Attribution function.

Api

Inherited from

ImageCanvas.getAttributions

---

getAttributionsCollapsible()

getAttributionsCollapsible(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:155

Returns

boolean

Attributions are collapsible.

Api

Inherited from

ImageCanvas.getAttributionsCollapsible

---

getGraphicBy()

getGraphicBy(key, value): Graphic | null;

Defined in: packages/core-ol/src/layers/massLayer.ts:254

Parameters

key

string

value

unknown

Returns

Graphic | null

---

getGraphicById()

getGraphicById(id): Graphic | null;

Defined in: packages/core-ol/src/layers/massLayer.ts:262

Parameters

id

string | number

Returns

Graphic | null

---

getGraphicsByAttribute()

getGraphicsByAttribute(key, value): Graphic[];

Defined in: packages/core-ol/src/layers/massLayer.ts:266

Parameters

key

string

value

unknown

Returns

Graphic[]

---

getGraphicsInExtent()

getGraphicsInExtent(extent?): Graphic[];

Defined in: packages/core-ol/src/layers/massLayer.ts:295

Parameters

extent?

Extent

Returns

Graphic[]

---

getImage()

getImage(
   extent, 
   resolution, 
   pixelRatio, 
   projection): ImageWrapper;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:192

Parameters

extent

Extent

Extent.

resolution

number

Resolution.

pixelRatio

number

Pixel ratio.

projection

Projection

Projection.

Returns

ImageWrapper

Single image.

Inherited from

ImageCanvas.getImage

---

getImageInternal()

getImageInternal(
   extent, 
   resolution, 
   pixelRatio, 
   projection): ImageCanvas;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/ImageCanvas.d.ts:124

Parameters

extent

Extent

Extent.

resolution

number

Resolution.

pixelRatio

number

Pixel ratio.

projection

Projection

Projection.

Returns

ImageCanvas

Single image.

Inherited from

ImageCanvas.getImageInternal

---

getInterpolate()

getInterpolate(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:184

Returns

boolean

Use linear interpolation when resampling.

Inherited from

ImageCanvas.getInterpolate

---

getKeys()

getKeys(): string[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:120

Get a list of object property names.

Returns

string[]

List of property names.

Api

Inherited from

ImageCanvas.getKeys

---

getListeners()

getListeners(type): Listener[] | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:69

Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

Parameters

type

string

Type.

Returns

Listener[] | undefined

Listeners.

Inherited from

ImageCanvas.getListeners

---

getProjection()

getProjection(): Projection | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:161

Get the projection of the source.

Returns

Projection | null

Projection.

Api

Inherited from

ImageCanvas.getProjection

---

getProperties()

getProperties(): NoInfer<{
[x: string]: any;
}>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:126

Get an object of all property names and values.

Returns

NoInfer<{ [x: string]: any; }>

Object.

Api

Inherited from

ImageCanvas.getProperties

---

getPropertiesInternal()

getPropertiesInternal(): 
  | Partial<NoInfer<{
[x: string]: any;
}>>
  | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:131

Get an object of all property names and values.

Returns

| Partial<NoInfer<{ [x: string]: any; }>> | null

Object.

Inherited from

ImageCanvas.getPropertiesInternal

---

getResolutions()

getResolutions(): number[] | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:174

Returns

number[] | null

Resolutions.

Inherited from

ImageCanvas.getResolutions

---

getRevision()

getRevision(): number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:72

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns

number

Revision.

Api

Inherited from

ImageCanvas.getRevision

---

getState()

getState(): State;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:176

Get the state of the source, see import("./Source.js").State for possible states.

Returns

State

State.

Api

Inherited from

ImageCanvas.getState

---

getView()

getView(): Promise<ViewOptions>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:170

Returns

Promise<ViewOptions>

A promise for view-related properties.

Inherited from

ImageCanvas.getView

---

getWrapX()

getWrapX(): boolean | undefined;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:180

Returns

boolean | undefined

Wrap X.

Inherited from

ImageCanvas.getWrapX

---

handleImageChange()

protected handleImageChange(event): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:208

Handle image change events.

Parameters

event

BaseEvent

Event.

Returns

void

Inherited from

ImageCanvas.handleImageChange

---

hasListener()

hasListener(type?): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:75

Parameters

type?

string

Type. If not provided, true will be returned if this event target has any listeners.

Returns

boolean

Has listeners.

Inherited from

ImageCanvas.hasListener

---

hasProperties()

hasProperties(): boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:135

Returns

boolean

The object has properties.

Inherited from

ImageCanvas.hasProperties

---

notify()

notify(key, oldValue): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:140

Parameters

key

string

Key name.

oldValue

any

Old value.

Returns

void

Inherited from

ImageCanvas.notify

---

onceInternal()

protected onceInternal(type, listener): EventsKey | EventsKey[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:86

Parameters

type

string | string[]

Type.

listener

(arg0) => unknown

Listener.

Returns

EventsKey | EventsKey[]

Event key.

Inherited from

ImageCanvas.onceInternal

---

onInternal()

protected onInternal(type, listener): EventsKey | EventsKey[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:79

Parameters

type

string | string[]

Type.

listener

(arg0) => unknown

Listener.

Returns

EventsKey | EventsKey[]

Event key.

Inherited from

ImageCanvas.onInternal

---

refresh()

refresh(): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:189

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

Returns

void

Api

Inherited from

ImageCanvas.refresh

---

removeChangeListener()

removeChangeListener(key, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:150

Parameters

key

string

Key name.

listener

Listener

Listener.

Returns

void

Inherited from

ImageCanvas.removeChangeListener

---

removeEventListener()

removeEventListener(type, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/events/Target.d.ts:80

Parameters

type

string

Type.

listener

Listener

Listener.

Returns

void

Inherited from

ImageCanvas.removeEventListener

---

removeGraphics()

removeGraphics(graphics?): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:273

移除指定 graphics；不传则清空

Parameters

graphics?

Graphic | Graphic[] | null

Returns

void

---

set()

set(
   key, 
   value, 
   silent?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:158

Sets a value.

Parameters

key

string

Key name.

value

any

Value.

silent?

boolean

Update without triggering an event.

Returns

void

Api

Inherited from

ImageCanvas.set

---

setAttributions()

setAttributions(attributions): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:197

Set the attributions of the source.

Parameters

attributions

AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

Returns

void

Api

Inherited from

ImageCanvas.setAttributions

---

setGraphics()

setGraphics(graphics): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:239

重置全部 graphics（输入坐标为 WGS-84 经纬度）

Parameters

graphics

Graphic | Graphic[]

Returns

void

---

setProperties()

setProperties(values, silent?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:166

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Parameters

values

Partial<NoInfer<Properties>>

Values.

silent?

boolean

Update without triggering an event.

Returns

void

Api

Inherited from

ImageCanvas.setProperties

---

setResolutions()

setResolutions(resolutions): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Image.d.ts:178

Parameters

resolutions

number[] | null

Resolutions.

Returns

void

Inherited from

ImageCanvas.setResolutions

---

setState()

setState(state): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/Source.d.ts:202

Set the state of the source.

Parameters

state

State

State.

Returns

void

Inherited from

ImageCanvas.setState

---

unInternal()

protected unInternal(type, listener): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Observable.d.ts:93

Unlisten for a certain type of event.

Parameters

type

string | string[]

Type.

listener

(arg0) => unknown

Listener.

Returns

void

Inherited from

ImageCanvas.unInternal

---

unset()

unset(key, silent?): void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/Object.d.ts:179

Unsets a property.

Parameters

key

string

Key name.

silent?

boolean

Unset without triggering an event.

Returns

void

Api

Inherited from

ImageCanvas.unset

---

update()

update(): void;

Defined in: packages/core-ol/src/layers/massLayer.ts:291

Returns

void