NextGIS Frontend
    Preparing search index...

    Interface GeoJsonLayerAdapter<M, L, O, F>

    Adapter for vector data stored as GeoJSON.

    interface GeoJsonLayerAdapter<
        M = any,
        L = any,
        O extends
            VectorAdapterOptions<any, any, any, any, any> = GeoJsonAdapterOptions,
        F extends Feature = Feature,
    > {
        id?: string;
        layer?: L;
        map?: M;
        name?: string;
        options: O;
        order?: number;
        selected?: boolean;
        source?: unknown;
        addData(geojson: GeoJsonObject): void | Promise<void>;
        addLayer(options: O): L | Promise<L> | undefined;
        beforeRemove?(): void;
        clearLayer(cb?: (feature: F) => boolean): void | Promise<void>;
        closePopup?(findFeatureCb?: DataLayerFilter<F, L>): void;
        filter?(cb: DataLayerFilter<F, L>): LayerDefinition<F, L>[];
        getBounds?(): | LngLatBoundsArray
        | Promise<(LngLatBoundsArray | undefined)>
        | undefined;
        getDependLayers?(): L[];
        getExtent?(): | LngLatBoundsArray
        | Promise<(LngLatBoundsArray | undefined)>
        | undefined;
        getFiltered?(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[];
        getLayers(): LayerDefinition<F, L>[];
        getLegend?(options?: GetLegendOptions): Promise<LayerLegend[]>;
        getSelected(): LayerDefinition<F, L>[];
        hideLabel?(): void;
        hideLayer?(layer?: L): void;
        isLabelVisible?(): boolean;
        onLayerClick?(event: OnLayerMouseOptions): Promise<any>;
        openPopup?(
            findFeatureCb?: DataLayerFilter<F, L>,
            options?: PopupOptions<Feature<Geometry, GeoJsonProperties>, any>,
        ): void;
        propertiesFilter?(
            filters?:
                | PropertiesFilter<
                    (
                        F extends Feature<Geometry, GeoJsonProperties>
                            ? F["properties"]
                            : Record<string, string>
                    ) extends null
                        ? Record<string, any>
                        : F extends Feature<Geometry, GeoJsonProperties>
                            ? F["properties"]
                            : Record<string, string>,
                >
                | null,
            options?: FilterOptions<
                (
                    F extends Feature<Geometry, GeoJsonProperties>
                        ? F["properties"]
                        : Record<string, string>
                ) extends null
                    ? Record<string, any>
                    : F extends Feature<Geometry, GeoJsonProperties>
                        ? F["properties"]
                        : Record<string, string>,
            >,
        ): Promise<void>;
        removeFilter?(): void;
        removeLayer?(): void;
        select(findFeatureCb?: PropertiesFilter | DataLayerFilter<F, L>): void;
        setData(geojson: GeoJsonObject): void | Promise<void>;
        setOpacity?(val: number): void;
        setPaint?(paint: Paint): void;
        setSelectedPaint?(paint: Paint): void;
        showLabel?(): void;
        showLayer?(layer?: L): void;
        unselect(findFeatureCb?: PropertiesFilter | DataLayerFilter<F, L>): void;
        updateLayer?(options?: UpdateLayerAdapterOptions): void;
        updatePaint?(paint: Partial<Paint>): void;
        updateSelectedPaint?(paint: Partial<Paint>): void;
        updateTooltip?(layerDef?: LayerDefinition<F, L>): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    id? layer? map? name? options order? selected? source?
    addData addLayer beforeRemove? clearLayer closePopup? filter? getBounds? getDependLayers? getExtent? getFiltered? getLayers getLegend? getSelected hideLabel? hideLayer? isLabelVisible? onLayerClick? openPopup? propertiesFilter? removeFilter? removeLayer? select setData setOpacity? setPaint? setSelectedPaint? showLabel? showLayer? unselect updateLayer? updatePaint? updateSelectedPaint? updateTooltip?
    id?: string
    layer?: L
    map?: M
    name?: string
    options: O
    order?: number
    selected?: boolean

    True if there are selected features in the layer

    source?: unknown

    Experimental option, only for MVT. Points to a data source instead of loading data into a layer.

    • The way to filter layer objects through serializable expressions. To clear the filter, pass null or undefined as the second parameter.

      Parameters

      • Optionalfilters:
            | PropertiesFilter<
                (
                    F extends Feature<Geometry, GeoJsonProperties>
                        ? F["properties"]
                        : Record<string, string>
                ) extends null
                    ? Record<string, any>
                    : F extends Feature<Geometry, GeoJsonProperties>
                        ? F["properties"]
                        : Record<string, string>,
            >
            | null

        Filter, conforming to the PropertiesFilter expression specification's.

      • Optionaloptions: FilterOptions<
            (
                F extends Feature<Geometry, GeoJsonProperties>
                    ? F["properties"]
                    : Record<string, string>
            ) extends null
                ? Record<string, any>
                : F extends Feature<Geometry, GeoJsonProperties>
                    ? F["properties"]
                    : Record<string, string>,
        >

        Options object.

      Returns Promise<void>

      layer.propertiesFilter(['all', ['color', 'eq', 'green'], ['year', 'gt', 2011]]);
      layer.propertiesFilter([[
        'any',
        ['color', 'eq', 'green'],
        ['color', 'eq', 'red']
      ],
        ['year', 'gt', 2011]
      ]);

    Settings
    Member Visibility

    On This Page
    Properties
    Methods