Interface LegendItemAttributes

Attributes of the legend attribute that can be specified on a layer.

To show a legend for the layer, provide an imageUrl to an image to show or provide a React component that will be rendered as a legend.

LegendItemAttributes should be registered with a layer as the "legend" attribute.

interface LegendItemAttributes {
    Component?: ComponentType<LegendItemComponentProps>;
    imageUrl?: string;
    listMode?: ListMode;
}

Properties

Component?: ComponentType<LegendItemComponentProps>

(Optional) React component that will be shown as customized legend for the layer.

imageUrl?: string

(Optional) URL to an image that will be shown as a legend for the layer.

listMode?: ListMode

(Optional) Additional property to control the display of the layer in the legend.