SettingsSpec
@elastic/charts • Exports
@elastic/charts / SettingsSpec
Interface: SettingsSpec
The Spec used for Chart settings
Contents
- Extends
- Properties
- allowBrushingLastHistogramBin
- animateData
- ariaDescribedBy?
- ariaDescription?
- ariaLabel?
- ariaLabelHeadingLevel
- ariaLabelledBy?
- ariaTableCaption?
- ariaUseDefaultSummary
- baseTheme?
- brushAxis?
- chartType
- customLegend?
- debug
- debugState?
- dow
- externalPointerEvents
- flatLegend?
- id
- legendAction?
- legendColorPicker?
- legendMaxDepth
- legendPosition
- legendSize
- legendSort?
- legendStrategy?
- legendTitle?
- legendValues
- locale
- minBrushDelta?
- noResults?
- onAnnotationClick?
- onBrushEnd?
- onElementClick?
- onElementOut?
- onElementOver?
- onLegendItemClick?
- onLegendItemMinusClick?
- onLegendItemOut?
- onLegendItemOver?
- onLegendItemPlusClick?
- onPointerUpdate?
- onProjectionAreaChange?
- onProjectionClick?
- onRenderChange?
- onResize?
- onWillRender?
- orderOrdinalBinsBy?
- pointBuffer
- pointerUpdateDebounce?
- pointerUpdateTrigger
- rendering
- renderingSort?
resizeDebounce?- rotation
- roundHistogramBrushValues?
- showLegend
- specType
- theme?
- xDomain?
Extends
Properties
allowBrushingLastHistogramBin
allowBrushingLastHistogramBin:
boolean
Boolean to allow brushing on last bucket even when outside domain or limit to end of domain. Should apply only for histogram charts e.g. A brush selection range of [1.23, 3.6] with a domain of [1, 2, 3]
- when true returns [1.23, 3.6]
- when false returns [1.23, 3]
Default Value
true
Source
packages/charts/src/specs/settings.tsx:622
animateData
animateData:
boolean
Source
packages/charts/src/specs/settings.tsx:521
ariaDescribedBy?
ariaDescribedBy?:
string
- An DOM element ID for the chart description. If provided, it will override the ariaDescription prop.
Source
packages/charts/src/specs/settings.tsx:657
ariaDescription?
ariaDescription?:
string
A description about the chart.
Source
packages/charts/src/specs/settings.tsx:653
ariaLabel?
ariaLabel?:
string
A text to label the chart
Source
packages/charts/src/specs/settings.tsx:645
ariaLabelHeadingLevel
ariaLabelHeadingLevel:
"h1"
|"h2"
|"h3"
|"h4"
|"h5"
|"h6"
|"p"
User can specify the heading level for the label
Default Value
'p'
Source
packages/charts/src/specs/settings.tsx:641
ariaLabelledBy?
ariaLabelledBy?:
string
An DOM element ID for the chart label. If provided, it will override the ariaLabel prop.
Source
packages/charts/src/specs/settings.tsx:649
ariaTableCaption?
ariaTableCaption?:
string
User can provide a table description of the data
Source
packages/charts/src/specs/settings.tsx:666
ariaUseDefaultSummary
ariaUseDefaultSummary:
boolean
Renders an autogenerated summary of the chart
Default Value
true
Source
packages/charts/src/specs/settings.tsx:662
baseTheme?
baseTheme?:
Theme
Full default theme to use as base
Default Value
LIGHT_THEME
Source
packages/charts/src/specs/settings.tsx:518
brushAxis?
brushAxis?:
BrushAxis
Defines which axes are able to be brushed.
Default Value
x
(BrushAxis:type) | BrushAxis.X
Source
packages/charts/src/specs/settings.tsx:592
chartType
chartType:
ChartType
Chart type define the type of chart that use this spec
Inherited from
Source
packages/charts/src/specs/spec_type.ts:31
customLegend?
customLegend?:
CustomLegend
Override the legend with a custom component.
Inherited from
Source
packages/charts/src/specs/settings.tsx:490
debug
debug:
boolean
Show debug shadow elements on chart
Source
packages/charts/src/specs/settings.tsx:531
debugState?
debugState?:
boolean
Show debug render state on ChartStatus
component
Source
packages/charts/src/specs/settings.tsx:536
dow
dow:
number
Refers to the first day of the week as an index.
Expressed according to ISO 8601
where 1
is Monday, 2
is Tuesday, ..., 6
is Saturday and 7
is Sunday
Default Value
1 (i.e. Monday)
Source
packages/charts/src/specs/settings.tsx:680
externalPointerEvents
externalPointerEvents:
ExternalPointerEventsSettings
The settings for handling external events. TODO consider moving this to Tooltip spec
Source
packages/charts/src/specs/settings.tsx:527
flatLegend?
flatLegend?:
boolean
Display the legend as a flat list.
Default Value
false
Inherited from
Source
packages/charts/src/specs/settings.tsx:467
id
id:
string
unique Spec identifier
Inherited from
Source
packages/charts/src/specs/spec_type.ts:29
legendAction?
legendAction?:
LegendAction
Render slot to render action for legend
Inherited from
Source
packages/charts/src/specs/settings.tsx:481
legendColorPicker?
legendColorPicker?:
LegendColorPicker
Inherited from
Source
packages/charts/src/specs/settings.tsx:482
legendMaxDepth
legendMaxDepth:
number
Limit the legend to the specified maximal depth when showing a hierarchical legend
Remarks
This is not the max depth, but the number of level shown: 0 none, 1 first, 2 up to the second etc. See https://github.com/elastic/elastic-charts/issues/1981 for details
Inherited from
Source
packages/charts/src/specs/settings.tsx:455
legendPosition
legendPosition:
Position
|LegendPositionConfig
Set legend position
Default Value
Position.Right
Inherited from
Source
packages/charts/src/specs/settings.tsx:442
legendSize
legendSize:
number
Sets the exact legend width (vertical) or height (horizontal)
Limited to max of 70% of the chart container dimension Vertical legends limited to min of 30% of computed width
Inherited from
Source
packages/charts/src/specs/settings.tsx:462
legendSort?
legendSort?:
SeriesCompareFn
A SeriesSortFn to sort the legend values (top-bottom)
Inherited from
Source
packages/charts/src/specs/settings.tsx:486
legendStrategy?
legendStrategy?:
LegendStrategy
Choose a partition highlighting strategy for hovering over legend items.
Default Value
LegendStrategy.Path
Inherited from
Source
packages/charts/src/specs/settings.tsx:472
legendTitle?
legendTitle?:
string
a title for the table legend
Inherited from
Source
packages/charts/src/specs/settings.tsx:494
legendValues
legendValues:
LegendValue
[]
Add one or more computed statistics to each legend item. The available statistics depends by chart type.
Inherited from
Source
packages/charts/src/specs/settings.tsx:447
locale
locale:
string
Unicode Locale Identifier, default en-US
Source
packages/charts/src/specs/settings.tsx:671
minBrushDelta?
minBrushDelta?:
number
The minimum number of pixel to consider for a valid brush event (in both axis if brushAxis prop is BrushAxis.Both). E.g. a min value of 2 means that the brush area needs to be at least 2 pixel wide and 2 pixel tall.
Default Value
2
Source
packages/charts/src/specs/settings.tsx:598
noResults?
noResults?:
ReactChild
|ComponentType
Render component for no results UI
Source
packages/charts/src/specs/settings.tsx:636