Class LegendHelper

Helper functions for creating track legends.

Constructors

constructor

Methods

basicLegendSvgConfig basicVerticalLabel basicVerticalLinkLabel renderBasicVerticalSvgLabel

Constructors

constructor

Methods

Static basicLegendSvgConfig

  • basicLegendSvgConfig(trackRowsFunc, updateFunc): LegendConfig

  • Creates a basic legend config required by the wellog component

    Parameters

    • trackRowsFunc: LegendRowsFunction
    • updateFunc: LegendOnUpdateFunction

    Returns LegendConfig

Static basicVerticalLabel

  • basicVerticalLabel(label, abbr): LegendConfig

  • Convenience function for quickly creating a legend config object for a rotated label legend.

    Parameters

    • label: string
    • abbr: string

    Returns LegendConfig

Static basicVerticalLinkLabel

  • basicVerticalLinkLabel(__namedParameters): LegendConfig

  • Convenience function for creating a legend config object for a clickable rotated label legend.

    Parameters

    • __namedParameters: BasicVerticalLinkLabelConfig

    Returns LegendConfig

Static renderBasicVerticalSvgLabel

  • renderBasicVerticalSvgLabel(g, bounds, label, abbr, horizontal?): any

  • Renders a simple rotated text label that is scaled to fit bounds

    Parameters

    • g: any
    • bounds: LegendBounds
    • label: string
    • abbr: string
    • horizontal: boolean = false

    Returns any

Settings

Member Visibility

Theme

On This Page

constructorbasicLegendSvgConfigbasicVerticalLabelbasicVerticalLinkLabelrenderBasicVerticalSvgLabel

Generated using TypeDoc