Table of Contents

Class MapDimension

Namespace
BiExcellence.OpenBi.Api.MapDimensions
Assembly
BiExcellence.OpenBi.Api.Client.dll

A geo-mapping dimension, stored in the caller's own organisation database. It tells the geo lookup which characteristic of a query carries a place name, which is what lets GET dataproviders/{id}/griddata with withMaps=true put coordinates on cells.

public sealed record MapDimension : IMapDimension
Inheritance
object
MapDimension
Implements

Properties

Description

A free-text description of the map dimension.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

DimensionId

The technical name of the characteristic whose values are places. When it is in the rows of a query, its values are looked up in the server's geocoding table for their coordinates.

[JsonPropertyName("dimensionId")]
public string? DimensionId { get; init; }

Property Value

string

Id

The id of the map dimension; a GUID is generated when it is omitted on create.

[JsonPropertyName("id")]
public string? Id { get; init; }

Property Value

string