IInsightLayerDefinition
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Defines a single layer in a multi-layer visualization (e.g., geo charts).
export interface IInsightLayerDefinition
Remarks
Each layer has its own buckets, filters, sorts, and properties, allowing independent data configuration per layer.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Attribute filter configurations for this layer | |||
IBucket[] | (ALPHA) Buckets containing attributes/measures for this layer | ||
IFilter[] | (ALPHA) (Optional) Filters specific to this layer | ||
string | (ALPHA) Unique identifier for this layer | ||
string | (ALPHA) (Optional) Optional human-readable name for the layer | ||
(ALPHA) (Optional) Layer-specific visualization properties | |||
(ALPHA) (Optional) Sorting configuration for this layer | |||
string | (ALPHA) Layer visualization type (e.g., “pushpin”, “area”) |
Property details
IInsightLayerDefinition.attributeFilterConfigspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Attribute filter configurations for this layer
attributeFilterConfigs?: IAttributeFilterConfigs;
Remarks
If not set, the layer will inherit the attribute filter configs from the root insight definition.
IInsightLayerDefinition.bucketspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Buckets containing attributes/measures for this layer
buckets: IBucket[];
IInsightLayerDefinition.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Filters specific to this layer
filters?: IFilter[];
Remarks
If not set, the layer will inherit the filters from the root insight definition.
IInsightLayerDefinition.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Unique identifier for this layer
id: string;
IInsightLayerDefinition.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Optional human-readable name for the layer
name?: string;
IInsightLayerDefinition.propertiespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Layer-specific visualization properties
properties?: VisualizationProperties;
Remarks
If not set, the layer will inherit the properties from the root insight definition.
IInsightLayerDefinition.sortspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sorting configuration for this layer
sorts?: ISortItem[];
Remarks
If not set, the layer will inherit the sorting from the root insight definition.
IInsightLayerDefinition.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Layer visualization type (e.g., “pushpin”, “area”)
type: string;
Remarks
This determines how the layer data should be visualized. For geo charts: “pushpin” for point-based layers, “area” for polygon-based layers.