Class LegendHelper

Helper functions for creating track legends.

Index

Constructors

Methods

basicLegendSvgConfig basicVerticalLabel basicVerticalLinkLabel renderBasicVerticalSvgLabel

Constructors

constructor

new LegendHelper(): LegendHelper
Returns LegendHelper

Methods

`Static`basicLegendSvgConfig

basicLegendSvgConfig(
trackRowsFunc: LegendRowsFunction,
updateFunc: LegendOnUpdateFunction,
): LegendConfig
Creates a basic legend config required by the wellog component
Parameters
- trackRowsFunc: LegendRowsFunction
- updateFunc: LegendOnUpdateFunction
Returns LegendConfig
- Defined in utils/legend-helper.ts:49

`Static`basicVerticalLabel

basicVerticalLabel(label: string, abbr: string): LegendConfig
Convenience function for quickly creating a legend config object for a rotated label legend.
Parameters
- label: string
- abbr: string
Returns LegendConfig
- Defined in utils/legend-helper.ts:106

`Static`basicVerticalLinkLabel

basicVerticalLinkLabel(
__namedParameters: BasicVerticalLinkLabelConfig,
): LegendConfig
Convenience function for creating a legend config object for a clickable rotated label legend.
Parameters
- __namedParameters: BasicVerticalLinkLabelConfig
Returns LegendConfig
- Defined in utils/legend-helper.ts:125

`Static`renderBasicVerticalSvgLabel

renderBasicVerticalSvgLabel(
    g: any,
    bounds: LegendBounds,
    label: string,
    abbr: string,
    horizontal?: boolean,
): 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
- Defined in utils/legend-helper.ts:69