PilotGaea 2D O'view
    正在準備搜尋索引...

    類別 Cluster

    Layer source to cluster vector data. Works out of the box with point geometries. For other geometry types, or if not all geometries should be considered for clustering, a custom geometryFunction can be defined.

    Constructor options.

    層級 (查看層級一覽)

    索引

    方法

    unByKey getSource setDistance addFeature addFeatures clear forEachFeature forEachFeatureInExtent forEachFeatureIntersectingExtent getFeaturesCollection getFeatures getFeaturesAtCoordinate getFeaturesInExtent getClosestFeatureToCoordinate getExtent getFeatureById getFormat getUrl removeFeature getAttributions getLogo getProjection getState refresh setAttributions get getKeys getProperties set setProperties unset changed dispatchEvent getRevision on once un unByKey

    構造函數

    constructor

    方法

    • Removes an event listener using the key returned by on() or once().

      參數

      • key: Object | Object[]

        The key returned by on() or once() (or an array of keys).

      回傳 void

      stable

    • Get a reference to the wrapped source.

      回傳 ol.source.Vector

      Source.

    • Set the distance in pixels between clusters.

      參數

      • distance: number

        The distance in pixels.

      回傳 void

    • Add a single feature to the source. If you want to add a batch of features at once, call source.addFeatures() instead.

      參數

      回傳 void

      stable

    • Add a batch of features to the source.

      參數

      回傳 void

      stable

    • Remove all features from the source.

      參數

      • 可選opt_fast: boolean

        Skip dispatching of removefeature events.

      回傳 void

      stable

    • Iterate through all features on the source, calling the provided callback with each one. If the callback returns any "truthy" value, iteration will stop and the function will return the same value.

      類型參數

      • T
      • S

      參數

      • callback: (feature: ol.Feature) => S

        Called with each feature on the source. Return a truthy value to stop iteration.

      • 可選opt_this: T

        The object to use as this in the callback.

      回傳 S

      The return value from the last call to the callback.

      stable

    • Iterate through all features whose bounding box intersects the provided extent (note that the feature's geometry may not intersect the extent), calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

      If you are interested in features whose geometry intersects an extent, call the * source.forEachFeatureIntersectingExtent() method instead.

      When useSpatialIndex is set to false, this method will loop through all features, equivalent to ol.source.Vector#forEachFeature.

      類型參數

      • T
      • S

      參數

      • extent: Extent

        Extent.

      • callback: (feature: ol.Feature) => S

        Called with each feature whose bounding box intersects the provided extent.

      • 可選opt_this: T

        The object to use as this in the callback.

      回傳 S

      The return value from the last call to the callback.

    • Iterate through all features whose geometry intersects the provided extent, calling the callback with each feature. If the callback returns a "truthy" value, iteration will stop and the function will return the same value.

      If you only want to test for bounding box intersection, call the * source.forEachFeatureInExtent() method instead.

      類型參數

      • T
      • S

      參數

      • extent: Extent

        Extent.

      • callback: (feature: ol.Feature) => S

        Called with each feature whose geometry intersects the provided extent.

      • 可選opt_this: T

        The object to use as this in the callback.

      回傳 S

      The return value from the last call to the callback.

    • Get all features in the provided extent. Note that this returns all features whose bounding boxes intersect the given extent (so it may include features whose geometries do not intersect the extent).

      This method is not available when the source is configured with useSpatialIndex set to false.

      參數

      回傳 ol.Feature[]

      Features.

    • Get the closest feature to the provided coordinate.

      This method is not available when the source is configured with useSpatialIndex set to false.

      參數

      • coordinate: Coordinate

        Coordinate.

      • 可選opt_filter: (feature: ol.Feature) => boolean

        Feature filter function. The filter function will receive one argument, the feature and it should return a boolean value. By default, no filtering is made.

      回傳 ol.Feature

      Closest feature.

      stable

    • Get the extent of the features currently in the source.

      This method is not available when the source is configured with useSpatialIndex set to false.

      回傳 Extent

      Extent.

      stable

    • Get a feature by its identifier (the value returned by feature.getId()). Note that the index treats string and numeric identifiers as the same. So source.getFeatureById(2) will return a feature with id '2' or 2.

      參數

      • id: string | number

        Feature identifier.

      回傳 ol.Feature

      The feature (or null if not found).

      stable

    • Remove a single feature from the source. If you want to remove all features at once, use the source.clear() method instead.

      參數

      回傳 void

      stable

    • Refreshes the source and finally dispatches a 'change' event.

      回傳 void

    • Set the attributions of the source.

      參數

      • attributions: AttributionLike

        Attributions. Can be passed as string, Array<string>, {@link ol.Attribution}, Array<{@link ol.Attribution}> or undefined.

      回傳 void

    • Gets a value.

      參數

      • key: string

        Key name.

      回傳 any

      Value.

      stable

    • Get a list of object property names.

      回傳 string[]

      List of property names.

      stable

    • Get an object of all property names and values.

      回傳 { [k: string]: any }

      Object.

      stable

    • Sets a value.

      參數

      • key: string

        Key name.

      • value: any

        Value.

      • 可選opt_silent: boolean

        Update without triggering an event.

      回傳 void

      stable

    • 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).

      參數

      • values: { [k: string]: any }

        Values.

      • 可選opt_silent: boolean

        Update without triggering an event.

      回傳 void

      stable

    • Unsets a property.

      參數

      • key: string

        Key name.

      • 可選opt_silent: boolean

        Unset without triggering an event.

      回傳 void

      stable

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

      回傳 void

    • 函數

      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.

      參數

      回傳 void

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

      回傳 number

      Revision.

    • Listen for a certain type of event.

      參數

      • type: string | string[]

        The event type or array of event types.

      • listener: Function

        The listener function.

      • 可選opt_this: Object

        The object to use as this in listener.

      回傳 Object | Object[]

      Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

      stable

    • Listen once for a certain type of event.

      參數

      • type: string | string[]

        The event type or array of event types.

      • listener: Function

        The listener function.

      • 可選opt_this: Object

        The object to use as this in listener.

      回傳 Object | Object[]

      Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

      stable

    • Unlisten for a certain type of event.

      參數

      • type: string | string[]

        The event type or array of event types.

      • listener: Function

        The listener function.

      • 可選opt_this: Object

        The object which was used as this by the listener.

      回傳 void

      stable

    • 函數

      Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

      參數

      • key: Object | Object[]

        The key returned by on() or once() (or an array of keys).

      回傳 void

      stable

    構造函數

    • 參數

      回傳 Cluster

      Layer source to cluster vector data. Works out of the box with point geometries. For other geometry types, or if not all geometries should be considered for clustering, a custom geometryFunction can be defined.

    顯示設定

    成員可見性

    目錄

    方法
    構造函數