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:602
animateData
animateData:
boolean
Source
packages/charts/src/specs/settings.tsx:501
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:637
ariaDescription?
ariaDescription?:
string
A description about the chart.
Source
packages/charts/src/specs/settings.tsx:633
ariaLabel?
ariaLabel?:
string
A text to label the chart
Source
packages/charts/src/specs/settings.tsx:625
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:621
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:629
ariaTableCaption?
ariaTableCaption?:
string
User can provide a table description of the data
Source
packages/charts/src/specs/settings.tsx:646
ariaUseDefaultSummary
ariaUseDefaultSummary:
boolean
Renders an autogenerated summary of the chart
Default Value
true
Source
packages/charts/src/specs/settings.tsx:642
baseTheme?
baseTheme?:
Theme
Full default theme to use as base
Default Value
LIGHT_THEME
Source
packages/charts/src/specs/settings.tsx:498
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:572
chartType
chartType:
ChartType
Chart type define the type of chart that use this spec
Inherited from
Source
packages/charts/src/specs/index.ts:16
customLegend?
customLegend?:
CustomLegend
Override the legend with a custom component.
Inherited from
Source
packages/charts/src/specs/settings.tsx:470
debug
debug:
boolean
Show debug shadow elements on chart
Source
packages/charts/src/specs/settings.tsx:511
debugState?
debugState?:
boolean
Show debug render state on ChartStatus
component
Source
packages/charts/src/specs/settings.tsx:516
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:660
externalPointerEvents
externalPointerEvents:
ExternalPointerEventsSettings
The settings for handling external events. TODO consider moving this to Tooltip spec
Source
packages/charts/src/specs/settings.tsx:507
flatLegend?
flatLegend?:
boolean
Display the legend as a flat list.
Default Value
false
Inherited from
Source
packages/charts/src/specs/settings.tsx:447
id
id:
string
unique Spec identifier
Inherited from
Source
packages/charts/src/specs/index.ts:14
legendAction?
legendAction?:
LegendAction
Render slot to render action for legend
Inherited from
Source
packages/charts/src/specs/settings.tsx:461
legendColorPicker?
legendColorPicker?:
LegendColorPicker
Inherited from
Source
packages/charts/src/specs/settings.tsx:462
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:435
legendPosition
legendPosition:
Position
|LegendPositionConfig
Set legend position
Default Value
Position.Right
Inherited from
Source
packages/charts/src/specs/settings.tsx:422
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:442
legendSort?
legendSort?:
SeriesCompareFn
A SeriesSortFn to sort the legend values (top-bottom)
Inherited from
Source
packages/charts/src/specs/settings.tsx:466
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:452
legendTitle?
legendTitle?:
string
a title for the table legend
Inherited from
Source
packages/charts/src/specs/settings.tsx:474
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:427
locale
locale:
string
Unicode Locale Identifier, default en-US
Source
packages/charts/src/specs/settings.tsx:651
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:578
noResults?
noResults?:
ReactChild
|ComponentType
Render component for no results UI
Source
packages/charts/src/specs/settings.tsx:616
onAnnotationClick?
onAnnotationClick?:
AnnotationClickListener
allows user to set a click handler to the annotations
Source
packages/charts/src/specs/settings.tsx:544
onBrushEnd?
onBrushEnd?:
BrushEndListener
Source
packages/charts/src/specs/settings.tsx:526
onElementClick?
onElementClick?:
ElementClickListener
Source
packages/charts/src/specs/settings.tsx:523
onElementOut?
onElementOut?:
BasicListener
Source
packages/charts/src/specs/settings.tsx:525
onElementOver?
onElementOver?:
ElementOverListener
Source
packages/charts/src/specs/settings.tsx:524
onLegendItemClick?
onLegendItemClick?:
LegendItemListener
Inherited from
Source
packages/charts/src/specs/settings.tsx:455
onLegendItemMinusClick?
onLegendItemMinusClick?:
LegendItemListener
Inherited from
LegendSpec.onLegendItemMinusClick
Source
packages/charts/src/specs/settings.tsx:457
onLegendItemOut?
onLegendItemOut?:
BasicListener
Inherited from
Source
packages/charts/src/specs/settings.tsx:454
onLegendItemOver?
onLegendItemOver?:
LegendItemListener
Inherited from
Source
packages/charts/src/specs/settings.tsx:453
onLegendItemPlusClick?
onLegendItemPlusClick?:
LegendItemListener
Inherited from
LegendSpec.onLegendItemPlusClick
Source
packages/charts/src/specs/settings.tsx:456
onPointerUpdate?
onPointerUpdate?:
PointerUpdateListener
Source
packages/charts/src/specs/settings.tsx:527
onProjectionAreaChange?
onProjectionAreaChange?:
ProjectionAreaChangeListener
Source
packages/charts/src/specs/settings.tsx:534
onProjectionClick?
onProjectionClick?:
ProjectionClickListener
Attach a listener for click on the projection area. The listener will be called with the current x value snapped to the closest X axis point, and an array of Y values for every groupId used in the chart.
Source
packages/charts/src/specs/settings.tsx:522
onRenderChange?
onRenderChange?:
RenderChangeListener
Source
packages/charts/src/specs/settings.tsx:532
onResize?
onResize?:
ResizeListener
subject to be removed in the future
Source
packages/charts/src/specs/settings.tsx:531
onWillRender?
onWillRender?:
WillRenderListener
Source
packages/charts/src/specs/settings.tsx:533
orderOrdinalBinsBy?
orderOrdinalBinsBy?:
OrderBy
Orders ordinal x values
Source
packages/charts/src/specs/settings.tsx:606
pointBuffer
pointBuffer:
MarkBuffer
The min distance from the rendered point circumference to highlight a cartesian data point in line/area/bubble charts.
Source
packages/charts/src/specs/settings.tsx:539
pointerUpdateDebounce?
pointerUpdateDebounce?:
number
debounce delay used for onPointerUpdate listener
Source
packages/charts/src/specs/settings.tsx:555
pointerUpdateTrigger
pointerUpdateTrigger:
PointerUpdateTrigger
trigger for onPointerUpdate listener.
'x'
- only triggers lister when x value changes'y'
- only triggers lister when y values change'both'
- triggers lister when x or y values change
Default Value
'x'
Source
packages/charts/src/specs/settings.tsx:566
rendering
rendering:
Rendering
Source
packages/charts/src/specs/settings.tsx:499
renderingSort?
renderingSort?:
SeriesCompareFn
A SeriesSortFn to sort the rendering order of series. Left/right for cluster, bottom-up for stacked. Currently available only on XY charts
Source
packages/charts/src/specs/settings.tsx:612
resizeDebounce?
resizeDebounce?:
number
debounce delay used for resizing chart
Deprecated
currently unused
Source
packages/charts/src/specs/settings.tsx:550
rotation
rotation:
Rotation
Source
packages/charts/src/specs/settings.tsx:500
roundHistogramBrushValues?
roundHistogramBrushValues?:
boolean
Boolean to round brushed values to nearest step bounds.
e.g. A brush selection range of [1.23, 3.6] with a domain of [1, 2, 3, 4].
- when true returns [1, 3]
- when false returns [1.23, 3.6]
Default Value
false
Source
packages/charts/src/specs/settings.tsx:590
showLegend
showLegend:
boolean
Show the legend
Default Value
false
Inherited from
Source
packages/charts/src/specs/settings.tsx:417
specType
specType:
string
The type of spec, can be series, axis, annotation, settings etc
Inherited from
Source
packages/charts/src/specs/index.ts:18
theme?
theme?:
RecursivePartial
<Theme
> |RecursivePartial
<Theme
>[]
Partial theme to be merged with base
or
Array of partial themes to be merged with base
index 0
being the highest priority
i.e. [primary, secondary, tertiary]
Source
packages/charts/src/specs/settings.tsx:492
xDomain?
xDomain?:
CustomXDomain
Source
packages/charts/src/specs/settings.tsx:540
Generated using typedoc-plugin-markdown and TypeDoc