Interface Attachable

Object which can be attached to a LegendBox

Hierarchy

  • Attachable

Implemented by

Properties

styleLegendEntry?

Methods

attach

Properties

Optional styleLegendEntry

styleLegendEntry?: ((entry: LegendBoxEntry<UIBackground>, matchStyleExactly?: boolean) => void)

Type declaration

    • (entry: LegendBoxEntry<UIBackground>, matchStyleExactly?: boolean): void

    • Match legend entry style to reflect components own style.

      Parameters

      • entry: LegendBoxEntry<UIBackground>
      • Optional matchStyleExactly: boolean

        By default, entries are assigned a smooth looking gradient based on the component color. If this flag is true, then this is skipped, and exact component solid fill is used instead.

      Returns void

Methods

attach

  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry<UIBackground>

      Object which has to be attached

    • toggleVisibilityOnClick: boolean

      Flag that indicates whether the Attachable should be hidden or not, when its respective Entry is clicked.

    • matchStyleExactly: boolean

      By default, entries are assigned a smooth looking gradient based on the component color. If this flag is true, then this is skipped, and exact component solid fill is used instead.

    Returns void

Settings

Member Visibility

Theme