Type Alias TShapeState

TShapeState: {
    altitude: number;
    bevel?: {
        enabled?: boolean;
        offset?: number;
        segments?: number;
        size?: number;
        thickness?: number;
    };
    color: string;
    height: number;
    hoverColor?: string;
    interactive: boolean
    | "pass-through";
    opacity: number;
    position: Coordinate;
    type: "shape";
    visible: boolean;
}

The serialized state of a shape feature collection, including its geometry and styling.

Type declaration

  • altitude: number

    The altitude of the shape.

    0
    
  • Optionalbevel?: {
        enabled?: boolean;
        offset?: number;
        segments?: number;
        size?: number;
        thickness?: number;
    }

    Bevel configuration for extruded shapes.

  • color: string

    The color of the shape.

    #ffffff
    
  • height: number

    The height of the shape. Height cannot be updated at this time

  • OptionalhoverColor?: string

    Color of the shape when hovered. Color can be set using CSS color names DarkGoldenRod, as hex strings #0000FF or rgb values rgb(255,0,0).

  • interactive: boolean | "pass-through"

    Controls how the shape participates in pointer-event raycasting.

    • true: hover and click handlers fire on this shape.
    • false (default): the shape captures the raycast — clicks land on it and stop there — but no hover or click handler fires. The shape still shields anything rendered behind it from receiving events.
    • 'pass-through': raycasts skip this shape entirely so pointer events fall through to whatever is rendered behind it. Useful for invisible helper shapes that must never block clicks beneath them.
    false
    
  • opacity: number

    The opacity of the shape.

    1
    
  • position: Coordinate

    The position of the shape as a Coordinate.

  • type: "shape"

    The type of the shape.

  • visible: boolean

    Whether Shape is visible

    true