Class MassifElements

Markers and popups; elements and styles are specs. The layer and source are created on first use, released with the map.

Index

Constructors

Methods

add clear layer onClick remove source style

Constructors

constructor

new MassifElements(
    map: MassifMap,
    id: string,
    sourceSpec?: {
        geometrySimplifier?: Handle;
        projection: string | Record<string, Json> | Handle<any>;
        spatialIndexType?:
            | "LOCAL_SPATIAL_INDEX_TYPE_NULL"
            | "LOCAL_SPATIAL_INDEX_TYPE_KDTREE";
        type: "local";
    },
): MassifElements
Parameters
- map: MassifMap
- id: string
- OptionalsourceSpec: {
      geometrySimplifier?: Handle;
      projection: string | Record<string, Json> | Handle<any>;
      spatialIndexType?:
          | "LOCAL_SPATIAL_INDEX_TYPE_NULL"
          | "LOCAL_SPATIAL_INDEX_TYPE_KDTREE";
      type: "local";
  }
  Where the positions are read. lon/lat by default, matching the rest of this API.
  - OptionalgeometrySimplifier?: Handle
    Returns the active geometry simplifier of the data source.
  - projection: string | Record<string, Json> | Handle<any>
  - OptionalspatialIndexType?: "LOCAL_SPATIAL_INDEX_TYPE_NULL" | "LOCAL_SPATIAL_INDEX_TYPE_KDTREE"
  - type: "local"
Returns MassifElements
- Defined in packages/ui-massifmaps/api/index.common.d.ts:299

Methods

add

add<T extends SpecType<"element">>(
spec: SpecArg<"element", T>,
): MassifObject<ClassOfSpec<"element", T>>
The spec's style either names a registered style or carries it inline.
Type Parameters
- T extends SpecType<"element">
Parameters
- spec: SpecArg<"element", T>
Returns MassifObject<ClassOfSpec<"element", T>>
- Defined in packages/ui-massifmaps/api/index.common.d.ts:303

clear

clear(): this
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:310

layer

layer(): MassifLayer<"massif::VectorLayer">
Returns MassifLayer<"massif::VectorLayer">
- Defined in packages/ui-massifmaps/api/index.common.d.ts:313

onClick

onClick(
    handler: (
        data: MassifEventData<"massif::VectorLayer", "vectorelement.clicked">,
    ) => void,
    options?: SubscribeOptions,
): Subscription
Set e.consumed to claim the tap, otherwise it also reaches the map.
Parameters
- handler: (data: MassifEventData<"massif::VectorLayer", "vectorelement.clicked">) => void
- Optionaloptions: SubscribeOptions
Returns Subscription
- Defined in packages/ui-massifmaps/api/index.common.d.ts:312

remove

remove(element: MassifObject<any>): boolean
The element stays registered until it is destroyed.
Parameters
- element: MassifObject<any>
Returns boolean
- Defined in packages/ui-massifmaps/api/index.common.d.ts:309

source

source(): MassifObject<"massif::LocalVectorDataSource">
Returns MassifObject<"massif::LocalVectorDataSource">
- Defined in packages/ui-massifmaps/api/index.common.d.ts:314

style

style<T extends SpecType<"elementstyle">>(
styleId: string,
spec: SpecArg<"elementstyle", T>,
): MassifObject<ClassOfSpec<"elementstyle", T>> & { id: string }
Lets many elements share ONE style object, which matters once there are thousands.
Type Parameters
- T extends SpecType<"elementstyle">
Parameters
- styleId: string
- spec: SpecArg<"elementstyle", T>
Returns MassifObject<ClassOfSpec<"elementstyle", T>> & { id: string }
- Defined in packages/ui-massifmaps/api/index.common.d.ts:305