IGeoLayerBase
Base interface for all geo layer configurations.
export interface IGeoLayerBase
Remarks
This interface defines the common properties shared by all layer types. Each layer operates independently with its own data execution, allowing different data sources, filters, and configurations per layer.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Color measure or attribute for this layer. | |||
(Optional) Optional per-layer configuration. | |||
(Optional) Filters specific to this layer. | |||
string | Unique identifier for this layer. | ||
string | (Optional) Human-readable name for the layer. | ||
(Optional) Segment attribute for categorization. | |||
(Optional) Sorting for this layer. | |||
(Optional) Tooltip text attribute for this layer. | |||
Layer type discriminator. |
Property details
IGeoLayerBase.colorproperty
Color measure or attribute for this layer.
color?: IAttributeOrMeasure;
Remarks
When a measure is provided, colors are determined by the measure values using a color scale (gradient). When an attribute is provided, colors are assigned categorically based on attribute values.
For pushpin layers, this affects the fill color of the markers. For area layers, this affects the fill color of the regions.
IGeoLayerBase.configproperty
Optional per-layer configuration.
config?: IGeoLayerConfig;
Remarks
This config is intentionally limited to layer-scoped options only.
IGeoLayerBase.filtersproperty
Filters specific to this layer.
filters?: INullableFilter[];
Remarks
Array of filters applied only to this layer’s data execution.
These filters are applied **before** any global/component-level filters (e.g. GeoChart.filters). When both layer and global filters are provided, the global filters are applied *after* the layer filters and therefore take precedence for filter types with “last wins” merge rules (for example date filters for the same date dataset or measure value filters for the same measure). Other filter types may accumulate according to SDK merge semantics.
IGeoLayerBase.idproperty
Unique identifier for this layer.
id: string;
Remarks
Used internally to track layer state and for debugging purposes. Each layer in a GeoChart must have a unique id.
IGeoLayerBase.nameproperty
Human-readable name for the layer.
name?: string;
Remarks
Optional display name that may be shown in legends or tooltips. If not provided, the layer id is used.
IGeoLayerBase.segmentByproperty
Segment attribute for categorization.
segmentBy?: IAttribute;
Remarks
Groups data points by the specified attribute, creating separate visual categories with distinct colors. When segmentBy is used, a category legend is displayed.
For pushpin layers, different segments get different marker colors. For area layers, different segments get different fill colors.
IGeoLayerBase.sortByproperty
Sorting for this layer.
sortBy?: ISortItem[];
Remarks
Defines how data points are sorted for this layer. Sorting can affect tooltip display order and rendering priority.
IGeoLayerBase.tooltipTextproperty
Tooltip text attribute for this layer.
tooltipText?: IAttribute;
Remarks
An attribute whose values are displayed in tooltips when hovering over data points in this layer. If not provided, falls back to the unified config’s tooltipText setting.
IGeoLayerBase.typeproperty
Layer type discriminator.
type: GeoLayerType;
Remarks
Determines the rendering mode for this layer. Use "pushpin" for point/marker data or "area" for region/polygon data.