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
Parameter | Type |
---|---|
containerNode | HTMLElement |
config? | HistogramConfigInterface |
Returns
Histogram
Overrides
DisplayStateManager
.constructor
Methods
extractConfig()
static
extractConfig(config
,defaultConfig
):DisplayStateConfigInterface
Parameters
Parameter | Type |
---|---|
config | DisplayStateConfigInterface |
defaultConfig | DisplayStateConfigInterface |
Returns
Inherited from
DisplayStateManager
.extractConfig
showState()
showState(
text?
):void
Shows the DisplayState element with the specified text
Parameters
Parameter | Type | Description |
---|---|---|
text? | string | Optional text to display, defaults to noDataMessage |
Returns
void
Inherited from
hideState()
hideState():
void
Hides the DisplayState element
Returns
void
Inherited from
setDisplayStateConfig()
setDisplayStateConfig(
config
):void
Updates the DisplayState configuration
Parameters
Parameter | Type |
---|---|
config | DisplayStateConfigInterface |
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
setConfig()
setConfig(
config?
):void
Parameters
Parameter | Type |
---|---|
config? | HistogramConfigInterface |
Returns
void
setSelection()
setSelection(
selection?
,renderOnly?
):void
Parameters
Parameter | Type | Default value |
---|---|---|
selection? | [number , number ] | undefined |
renderOnly? | boolean | false |
Returns
void
resize()
resize():
void
Returns
void
render()
render():
void
Returns
void
destroy()
destroy():
void
Cleanup method for DisplayState elements
Returns
void
Overrides
setHistogramData()
setHistogramData(
data
,customExtent?
):void
Parameters
Parameter | Type |
---|---|
data | undefined | number [] |
customExtent? | [number , number ] |
Returns
void
setHighlightedData()
setHighlightedData(
data
):void
Parameters
Parameter | Type |
---|---|
data | undefined | number [] |
Returns
void