TomTom Maps for JavaScript
    Preparing search index...

    Type Alias AreaAnalyticsRegionPolygonConfig

    Display configuration for the actual region boundary geometry.

    When area analytics data is shown, the original region polygon (the area the query was run for) is also rendered. Use this config to control its appearance.

    type AreaAnalyticsRegionPolygonConfig = {
        color?: string;
        fillOpacity?: number;
        inverted?: boolean;
        outlineOpacity?: number;
        outlineWidth?: number;
    }
    Index
    color? fillOpacity? inverted? outlineOpacity? outlineWidth?
    color?: string

    CSS colour used for both the fill and outline of the region boundary.

    When omitted, a theme-adaptive default is used. Known standard styles are classified as light or dark; a custom style is treated as light, so set color explicitly if a custom style is dark.

    Black (#000000) on light styles, white (#FFFFFF) on dark styles

    fillOpacity?: number

    Opacity of the region fill.

    0
    inverted?: boolean

    When true, renders the region as an overlay covering everything outside the polygon boundary, effectively tinting the area outside the analytics region.

    Uses a world-minus-polygon donut geometry (same technique as the GeometriesModule 'inverted' theme).

    false
    outlineOpacity?: number

    Opacity of the region outline.

    0.5
    outlineWidth?: number

    Width of the region outline in pixels.

    2

    Settings
    Member Visibility

    On This Page
    Properties