Class LegendHelper

Helper functions for creating track legends.

Hierarchy

LegendHelper

Index

Methods

Methods

Static basicLegendSvgConfig

basicLegendSvgConfig(trackRowsFunc: LegendRowsFunction, updateFunc: LegendOnUpdateFunction): LegendConfig

- Defined in utils/legend-helper.ts:34
Creates a basic legend config required by the wellog component

Parameters
- trackRowsFunc: LegendRowsFunction
- updateFunc: LegendOnUpdateFunction
Returns LegendConfig

Static basicVerticalLabel

basicVerticalLabel(label: string, abbr: string): LegendConfig

- Defined in utils/legend-helper.ts:80
Convenience function for quickly creating a legend config object for a rotated label legend.

Parameters
- label: string
- abbr: string
Returns LegendConfig

Static renderBasicVerticalSvgLabel

renderBasicVerticalSvgLabel(g: D3Selection, bounds: LegendBounds, label: string, abbr: string, horizontal?: boolean): void

- Defined in utils/legend-helper.ts:51
Renders a simple rotated text label that is scaled to fit bounds

Parameters
- g: D3Selection
- bounds: LegendBounds
- label: string
- abbr: string
- Default value horizontal: boolean = false
Returns void

Generated using TypeDoc