Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow custom MVT sources to style the map layers and provide custom legend #200656

Merged
merged 9 commits into from
Nov 26, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ export class MvtVectorLayer extends AbstractVectorLayer {
this._setMbPointsProperties(mbMap, sourceData.tileSourceLayer);
this._setMbLinePolygonProperties(mbMap, sourceData.tileSourceLayer);
this._syncTooManyFeaturesProperties(mbMap);
this.getSource().syncSourceStyle?.(mbMap, () =>
(this.getSource() as IMvtVectorSource).syncSourceStyle?.(mbMap, () =>
mbMap
.getStyle()
.layers.filter((mbLayer) => this.ownsMbLayerId(mbLayer.id))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
* 2.0.
*/

import type { Map as MbMap } from '@kbn/mapbox-gl';
import { ReactElement } from 'react';
import { VectorSourceRequestMeta } from '../../../../common/descriptor_types';
import { IVectorSource } from '.';
import { IVectorStyle } from '../../styles/vector/vector_style';

export interface IMvtVectorSource extends IVectorSource {
/*
Expand All @@ -25,4 +28,18 @@ export interface IMvtVectorSource extends IVectorSource {
* Use getTileSourceLayer to specify the displayed source layer.
*/
getTileSourceLayer(): string;

/**
* Syncs source specific styling with mbMap this allows custom sources to further style the map layers/filters
*/
syncSourceStyle?(mbMap: MbMap, getLayerIds: () => string[]): void;

/**
* specifies if a source provides its own legend details or if the default vector_style is used if the source has this method it must also implement renderLegendDetails
*/
hasLegendDetails?(): Promise<boolean>;
desean1625 marked this conversation as resolved.
Show resolved Hide resolved
/**
* specifies if a source provides its own legend details or if the default vector_style is used
*/
renderLegendDetails?(vectorStyle: IVectorStyle): ReactElement<any> | null;
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import React, { ReactElement } from 'react';
import React from 'react';
import {
FeatureCollection,
GeoJsonProperties,
Expand All @@ -17,7 +17,7 @@ import {
import type { KibanaExecutionContext } from '@kbn/core/public';
import { i18n } from '@kbn/i18n';
import type { Query } from '@kbn/data-plugin/common';
import type { MapGeoJSONFeature, Map as MbMap } from '@kbn/mapbox-gl';
import type { MapGeoJSONFeature } from '@kbn/mapbox-gl';
import { Filter } from '@kbn/es-query';
import type { TimeRange } from '@kbn/es-query';
import { Adapters } from '@kbn/inspector-plugin/common/adapters';
Expand All @@ -36,7 +36,6 @@ import {
} from '../../../../common/descriptor_types';
import { DataRequest } from '../../util/data_request';
import { FeatureGeometryFilterForm } from '../../../connected_components/mb_map/tooltip_control/features_tooltip';
import { IVectorStyle } from '../../styles/vector/vector_style';

export function hasVectorSourceMethod(
source: ISource,
Expand Down Expand Up @@ -146,20 +145,6 @@ export interface IVectorSource extends ISource {
* Provide unique ids for managing source requests in Inspector
*/
getInspectorRequestIds(): string[];

/**
* Syncs source specific styling with mbMap this allows custom sources to further style the map layers/filters
*/
syncSourceStyle?(mbMap: MbMap, getLayerIds: () => string[]): void;

/**
* specifies if a source provides its own legend details or if the default vector_style is used if the source has this method it must also implement renderLegendDetails
*/
hasLegendDetails?(): Promise<boolean>;
/**
* specifies if a source provides its own legend details or if the default vector_style is used
*/
renderLegendDetails?(vectorStyle: IVectorStyle): ReactElement<any> | null;
}

export class AbstractVectorSource extends AbstractSource implements IVectorSource {
Expand Down
22 changes: 16 additions & 6 deletions x-pack/plugins/maps/public/classes/styles/vector/vector_style.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ import { IStyle } from '../style';
import { IStyleProperty } from './properties/style_property';
import { IField } from '../../fields/field';
import { IVectorLayer } from '../../layers/vector_layer';
import { IVectorSource } from '../../sources/vector_source';
import { IMvtVectorSource, IVectorSource } from '../../sources/vector_source';
import { createStyleFieldsHelper, StyleFieldsHelper } from './style_fields_helper';
import { IESAggField } from '../../fields/agg';

Expand Down Expand Up @@ -721,17 +721,20 @@ export class VectorStyle implements IVectorStyle {
};

async hasLegendDetails() {
return this._source.hasLegendDetails
? await this._source.hasLegendDetails()
if (!this._source.isMvt()) {
return this._getLegendDetailStyleProperties().length > 0;
}
const source = this._source as IMvtVectorSource;

return source.hasLegendDetails && source.renderLegendDetails
? await source.hasLegendDetails()
: this._getLegendDetailStyleProperties().length > 0;
}

renderLegendDetails() {
const symbolId = this._getSymbolId();
const svg = symbolId ? this.getIconSvg(symbolId) : undefined;
return this._source.renderLegendDetails ? (
this._source.renderLegendDetails(this)
) : (
const VectorLegend = (
<VectorStyleLegend
masks={this._layer.getMasks()}
styles={this._getLegendDetailStyleProperties()}
Expand All @@ -741,6 +744,13 @@ export class VectorStyle implements IVectorStyle {
svg={svg}
/>
);

if (!this._source.isMvt()) {
return VectorLegend;
}

const source = this._source as IMvtVectorSource;
return source.renderLegendDetails ? source.renderLegendDetails(this) : VectorLegend;
}

clearFeatureState(featureCollection: FeatureCollection, mbMap: MbMap, sourceId: string) {
Expand Down