Class: Histogram

Base class that manages DisplayState UI states for data visualization components Used to encapsulate shared DisplayState logic

Extends

Constructors

Constructor

new Histogram(containerNode, config?): Histogram

Parameters

ParameterType
containerNodeHTMLElement
config?HistogramConfigInterface

Returns

Histogram

Overrides

DisplayStateManager.constructor

Methods

extractConfig()

static extractConfig(config, defaultConfig): DisplayStateConfigInterface

Parameters

ParameterType
configDisplayStateConfigInterface
defaultConfigDisplayStateConfigInterface

Returns

DisplayStateConfigInterface

Inherited from

DisplayStateManager.extractConfig


showState()

showState(text?): void

Shows the DisplayState element with the specified text

Parameters

ParameterTypeDescription
text?stringOptional text to display, defaults to noDataMessage

Returns

void

Inherited from

DisplayStateManager.showState


hideState()

hideState(): void

Hides the DisplayState element

Returns

void

Inherited from

DisplayStateManager.hideState


setDisplayStateConfig()

setDisplayStateConfig(config): void

Updates the DisplayState configuration

Parameters

ParameterType
configDisplayStateConfigInterface

Returns

void

Inherited from

DisplayStateManager.setDisplayStateConfig


setLoadingState()

setLoadingState(): void

Sets the DisplayState element to loading state

Returns

void

Overrides

DisplayStateManager.setLoadingState


getCurrentSelection()

getCurrentSelection(): undefined | number[]

Returns

undefined | number[]


getCurrentSelectionInPixels()

getCurrentSelectionInPixels(): number[]

Returns

number[]


getBarWidth()

getBarWidth(): number

Returns

number


getConfig()

getConfig(): HistogramConfigInterface

Returns

HistogramConfigInterface


setConfig()

setConfig(config?): void

Parameters

ParameterType
config?HistogramConfigInterface

Returns

void


setSelection()

setSelection(selection?, renderOnly?): void

Parameters

ParameterTypeDefault value
selection?[number, number]undefined
renderOnly?booleanfalse

Returns

void


resize()

resize(): void

Returns

void


render()

render(): void

Returns

void


destroy()

destroy(): void

Cleanup method for DisplayState elements

Returns

void

Overrides

DisplayStateManager.destroy


setHistogramData()

setHistogramData(data, customExtent?): void

Parameters

ParameterType
dataundefined | number[]
customExtent?[number, number]

Returns

void


setHighlightedData()

setHighlightedData(data): void

Parameters

ParameterType
dataundefined | number[]

Returns

void