@nativescript-community/ui-massifmaps
    Preparing search index...

    Interface LayerSpec_hillshade

    interface LayerSpec_hillshade {
        accentColor?: number;
        billboardsUnderLabels?: boolean;
        contourColor?: number;
        contourEnabled?: boolean;
        contourInterval?: number;
        contourWidth?: number;
        contrast?: number;
        cullDelay?: number;
        elevationEncodingEnabled?: boolean;
        exagerateHeightScaleEnabled?: boolean;
        exaggeration?: number;
        frameNr?: number;
        heightScale?: number;
        highlightColor?: number;
        hillshadeMethod?:
            | number
            | "STANDARD"
            | "COMBINED"
            | "IGOR"
            | "MULTIDIRECTIONAL"
            | "BASIC";
        illuminationDirection?: Position;
        illuminationMapRotationEnabled?: boolean;
        legacyHeightScaleEnabled?: boolean;
        maxOverzoomLevel?: number;
        maxUnderzoomLevel?: number;
        metaData?: Record<string, Json>;
        normalMapLightingShader?: string;
        opacity?: number;
        postProcessed?: boolean;
        preloading?: boolean;
        rasterTileEventListener?: Handle;
        shaderSource?: string;
        shadowColor?: number;
        source: string | Handle<any> | SourceSpec;
        synchronizedRefresh?: boolean;
        terrainPaintEnabled?: boolean;
        terrainPaintFullDetailEnabled?: boolean;
        textureCacheCapacity?: number;
        tileBlendingSpeed?: number;
        tileFilterMode?:
            | number
            | "RASTER_TILE_FILTER_MODE_NEAREST"
            | "RASTER_TILE_FILTER_MODE_BILINEAR"
            | "RASTER_TILE_FILTER_MODE_BICUBIC";
        tileLoadListener?: Handle;
        tileSubstitutionPolicy?: | number
        | "TILE_SUBSTITUTION_POLICY_ALL"
        | "TILE_SUBSTITUTION_POLICY_VISIBLE"
        | "TILE_SUBSTITUTION_POLICY_NONE";
        type: "hillshade";
        updatePriority?: number;
        UTFGridDataSource?: string
        | Handle<any>
        | SourceSpec;
        UTFGridEventListener?: Handle;
        visible?: boolean;
        visibleZoomRange?: [number, number];
        zoomLevelBias?: number;
    }
    Index

    Properties

    accentColor? billboardsUnderLabels? contourColor? contourEnabled? contourInterval? contourWidth? contrast? cullDelay? elevationEncodingEnabled? exagerateHeightScaleEnabled? exaggeration? frameNr? heightScale? highlightColor? hillshadeMethod? illuminationDirection? illuminationMapRotationEnabled? legacyHeightScaleEnabled? maxOverzoomLevel? maxUnderzoomLevel? metaData? normalMapLightingShader? opacity? postProcessed? preloading? rasterTileEventListener? shaderSource? shadowColor? source synchronizedRefresh? terrainPaintEnabled? terrainPaintFullDetailEnabled? textureCacheCapacity? tileBlendingSpeed? tileFilterMode? tileLoadListener? tileSubstitutionPolicy? type updatePriority? UTFGridDataSource? UTFGridEventListener? visible? visibleZoomRange? zoomLevelBias?

    Properties

    accentColor?: number

    Returns the shading color used to accentuate rugged terrain like sharp cliffs and gorges.

    billboardsUnderLabels?: boolean

    Returns whether the billboards of this layer (markers, popups) draw under the labels of the vector tile layers that render them last, rather than over everything. The default is false.

    contourColor?: number

    Returns the contour line color.

    contourEnabled?: boolean

    Returns whether GPU contour lines are drawn over the hillshade.

    contourInterval?: number

    Returns the spacing between contour lines in meters.

    contourWidth?: number

    Returns the contour line half-width in screen pixels.

    contrast?: number

    Returns the contrast of the hillshade overlay. This is the equivalent of MapLibre's 'hillshade-exaggeration' paint property: it controls the slope response curve and the overall strength of the shading, not the relief itself.

    cullDelay?: number

    Returns the culling delay of the layer in milliseconds.

    elevationEncodingEnabled?: boolean

    Returns whether the normal map encodes absolute elevation (so a custom normal-map lighting shader can call getElevation()).

    exagerateHeightScaleEnabled?: boolean

    Returns the normal vector tile should be exagerated based on the zoom level.

    exaggeration?: number

    Returns the per-frame relief exaggeration factor, i.e. the vertical exaggeration of the slope. Unlike height scale this is a shader uniform applied at render time (no tile re-decode), so it can be animated smoothly.

    frameNr?: number

    Returns the current frame number.

    heightScale?: number

    Returns the height scale of the hillshade overlay.

    highlightColor?: number

    Returns the shading color of areas that faces towards the light source.

    hillshadeMethod?:
        | number
        | "STANDARD"
        | "COMBINED"
        | "IGOR"
        | "MULTIDIRECTIONAL"
        | "BASIC"

    Returns the hillshade rendering method.

    illuminationDirection?: Position

    Returns the illumination direction of the layer.

    illuminationMapRotationEnabled?: boolean

    Returns whether the illumination direction should change with the map rotation.

    legacyHeightScaleEnabled?: boolean

    Returns whether the legacy (pre-MapLibre-parity) height scale formula is used.

    maxOverzoomLevel?: number

    Gets the current maximum overzoom level for this layer.

    maxUnderzoomLevel?: number

    Gets the current maximum underzoom level for this layer.

    metaData?: Record<string, Json>

    Returns a copy of the layer meta data map. The changes you make to this map are NOT reflected in the actual meta data of the layer.

    normalMapLightingShader?: string
    opacity?: number

    Returns the opacity of this layer.

    postProcessed?: boolean

    Returns whether this layer goes through the post-process effect.

    preloading?: boolean

    Returns the state of the preloading flag of this layer.

    rasterTileEventListener?: Handle

    Returns the raster tile event listener.

    shaderSource?: string

    Returns the custom fragment shader source.

    shadowColor?: number

    Returns the shading color of areas that face away from the light source.

    source: string | Handle<any> | SourceSpec
    synchronizedRefresh?: boolean

    Returns the state of the synchronized refresh flag.

    terrainPaintEnabled?: boolean

    Returns whether the layer may shade the 3D terrain's own elevation texture instead of loading a DEM tile set of its own.

    terrainPaintFullDetailEnabled?: boolean

    Returns whether the terrain paint shades from the elevation source's own maximum zoom.

    textureCacheCapacity?: number

    Returns the tile texture cache capacity.

    tileBlendingSpeed?: number

    Returns the current relative tile blending speed.

    tileFilterMode?:
        | number
        | "RASTER_TILE_FILTER_MODE_NEAREST"
        | "RASTER_TILE_FILTER_MODE_BILINEAR"
        | "RASTER_TILE_FILTER_MODE_BICUBIC"

    Returns the current tile filter mode.

    tileLoadListener?: Handle

    Returns the tile load listener.

    tileSubstitutionPolicy?:
        | number
        | "TILE_SUBSTITUTION_POLICY_ALL"
        | "TILE_SUBSTITUTION_POLICY_VISIBLE"
        | "TILE_SUBSTITUTION_POLICY_NONE"

    Returns the current tile substitution policy.

    type: "hillshade"
    updatePriority?: number

    Returns the layer task priority of this layer.

    UTFGridDataSource?: string | Handle<any> | SourceSpec

    Returns the tile data source of the associated UTF grid. By default this is null.

    UTFGridEventListener?: Handle

    Returns the UTF grid event listener.

    visible?: boolean

    Returns the visibility of this layer.

    visibleZoomRange?: [number, number]

    Returns the visible zoom range of this layer.

    zoomLevelBias?: number

    Gets the current zoom level bias for this layer.

    Settings

    Member Visibility

    On This Page

    Properties