BimCT SDK / WebGL2 Viewer
    Preparing search index...

    Type Alias LegendItem

    Represents a single item in the legend display. The visual representation follows a priority order: image > svg > color. Only one visual type will be used per item.

    type LegendItem = {
        label: string;
        color?: string;
        image?: HTMLImageElement;
        svg?: string;
    }
    Index

    Properties

    label color? image? svg?

    Properties

    label: string

    The text label displayed next to the icon.

    color?: string

    Color for the legend icon (CSS color string). Used only if neither image nor svg are provided.

    'gray'
    image?: HTMLImageElement

    HTML image element to display as the legend icon. Takes precedence over svg and color properties.

    svg?: string

    SVG markup or path data to display as the legend icon. Takes precedence over color but is overridden by image. Supports full SVG markup strings.

    Settings

    Member Visibility

    On This Page

    Properties