Skip to main content

SettingsSpec

@elastic/charts • Exports

@elastic/charts / SettingsSpec

Interface: SettingsSpec

The Spec used for Chart settings

Contents​

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:633

animateData​

animateData: boolean

Source​

packages/charts/src/specs/settings.tsx:532

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:668

ariaDescription?​

ariaDescription?: string

A description about the chart.

Source​

packages/charts/src/specs/settings.tsx:664

ariaLabel?​

ariaLabel?: string

A text to label the chart

Source​

packages/charts/src/specs/settings.tsx:656

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:652

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:660

ariaTableCaption?​

ariaTableCaption?: string

User can provide a table description of the data

Source​

packages/charts/src/specs/settings.tsx:677

ariaUseDefaultSummary​

ariaUseDefaultSummary: boolean

Renders an autogenerated summary of the chart

Default Value​

true

Source​

packages/charts/src/specs/settings.tsx:673

baseTheme?​

baseTheme?: Theme

Full default theme to use as base

Default Value​

LIGHT_THEME

Source​

packages/charts/src/specs/settings.tsx:529

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:603

chartType​

chartType: ChartType

Chart type define the type of chart that use this spec

Inherited from​

Spec.chartType

Source​

packages/charts/src/specs/spec_type.ts:31

customLegend?​

customLegend?: CustomLegend

Override the legend with a custom component.

Inherited from​

LegendSpec.customLegend

Source​

packages/charts/src/specs/settings.tsx:501

debug​

debug: boolean

Show debug shadow elements on chart

Source​

packages/charts/src/specs/settings.tsx:542

debugState?​

debugState?: boolean

Show debug render state on ChartStatus component

Source​

packages/charts/src/specs/settings.tsx:547

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:691

externalPointerEvents​

externalPointerEvents: ExternalPointerEventsSettings

The settings for handling external events. TODO consider moving this to Tooltip spec

Source​

packages/charts/src/specs/settings.tsx:538

flatLegend?​

flatLegend?: boolean

Display the legend as a flat list.

Default Value​

false

Inherited from​

LegendSpec.flatLegend

Source​

packages/charts/src/specs/settings.tsx:473

id​

id: string

unique Spec identifier

Inherited from​

Spec.id

Source​

packages/charts/src/specs/spec_type.ts:29

legendAction?​

legendAction?: LegendAction

Render slot to render action for legend

Inherited from​

LegendSpec.legendAction

Source​

packages/charts/src/specs/settings.tsx:487

legendActionOnHover?​

legendActionOnHover?: boolean

Display the legend action only on hover. When false, the action is always visible.

Default Value​

false

Inherited from​

LegendSpec.legendActionOnHover

Source​

packages/charts/src/specs/settings.tsx:492

legendColorPicker?​

legendColorPicker?: LegendColorPicker

Inherited from​

LegendSpec.legendColorPicker

Source​

packages/charts/src/specs/settings.tsx:493

legendLayout?​

legendLayout?: Layout

The layout of the legend

Default Value​

undefined

Inherited from​

LegendSpec.legendLayout

Source​

packages/charts/src/specs/settings.tsx:448

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​

LegendSpec.legendMaxDepth

Source​

packages/charts/src/specs/settings.tsx:461

legendPosition​

legendPosition: Position | LegendPositionConfig

Set legend position

Default Value​

Position.Right

Inherited from​

LegendSpec.legendPosition

Source​

packages/charts/src/specs/settings.tsx:443

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​

LegendSpec.legendSize

Source​

packages/charts/src/specs/settings.tsx:468

legendSort?​

legendSort?: SeriesCompareFn

A SeriesSortFn to sort the legend values (top-bottom)

Inherited from​

LegendSpec.legendSort

Source​

packages/charts/src/specs/settings.tsx:497

legendStrategy?​

legendStrategy?: LegendStrategy

Choose a partition highlighting strategy for hovering over legend items.

Default Value​

LegendStrategy.Path

Inherited from​

LegendSpec.legendStrategy

Source​

packages/charts/src/specs/settings.tsx:478

legendTitle?​

legendTitle?: string

a title for the table legend

Inherited from​

LegendSpec.legendTitle

Source​

packages/charts/src/specs/settings.tsx:505

legendValues​

legendValues: LegendValue[]

Add one or more computed statistics to each legend item. The available statistics depends by chart type.

Inherited from​

LegendSpec.legendValues

Source​

packages/charts/src/specs/settings.tsx:453

locale​

locale: string

Unicode Locale Identifier, default en-US

Source​

packages/charts/src/specs/settings.tsx:682

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:609

noResults?​

noResults?: ReactNode | ComponentType

Render component for no results UI

Source​

packages/charts/src/specs/settings.tsx:647

onAnnotationClick?​

onAnnotationClick?: AnnotationClickListener

allows user to set a click handler to the annotations

Source​

packages/charts/src/specs/settings.tsx:575

onBrushEnd?​

onBrushEnd?: BrushEndListener

Source​

packages/charts/src/specs/settings.tsx:557

onElementClick?​

onElementClick?: ElementClickListener

Source​

packages/charts/src/specs/settings.tsx:554

onElementOut?​

onElementOut?: BasicListener

Source​

packages/charts/src/specs/settings.tsx:556

onElementOver?​

onElementOver?: ElementOverListener

Source​

packages/charts/src/specs/settings.tsx:555

onLegendItemClick?​

onLegendItemClick?: LegendItemListener

Inherited from​

LegendSpec.onLegendItemClick

Source​

packages/charts/src/specs/settings.tsx:481

onLegendItemMinusClick?​

onLegendItemMinusClick?: LegendItemListener

Inherited from​

LegendSpec.onLegendItemMinusClick

Source​

packages/charts/src/specs/settings.tsx:483

onLegendItemOut?​

onLegendItemOut?: BasicListener

Inherited from​

LegendSpec.onLegendItemOut

Source​

packages/charts/src/specs/settings.tsx:480

onLegendItemOver?​

onLegendItemOver?: LegendItemListener

Inherited from​

LegendSpec.onLegendItemOver

Source​

packages/charts/src/specs/settings.tsx:479

onLegendItemPlusClick?​

onLegendItemPlusClick?: LegendItemListener

Inherited from​

LegendSpec.onLegendItemPlusClick

Source​

packages/charts/src/specs/settings.tsx:482

onPointerUpdate?​

onPointerUpdate?: PointerUpdateListener

Source​

packages/charts/src/specs/settings.tsx:558

onProjectionAreaChange?​

onProjectionAreaChange?: ProjectionAreaChangeListener

Source​

packages/charts/src/specs/settings.tsx:565

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:553

onRenderChange?​

onRenderChange?: RenderChangeListener

Source​

packages/charts/src/specs/settings.tsx:563

onResize?​

onResize?: ResizeListener

subject to be removed in the future

Source​

packages/charts/src/specs/settings.tsx:562

onWillRender?​

onWillRender?: WillRenderListener

Source​

packages/charts/src/specs/settings.tsx:564

orderOrdinalBinsBy?​

orderOrdinalBinsBy?: OrderBy

Orders ordinal x values

Source​

packages/charts/src/specs/settings.tsx:637

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:570

pointerUpdateDebounce?​

pointerUpdateDebounce?: number

debounce delay used for onPointerUpdate listener

Source​

packages/charts/src/specs/settings.tsx:586

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:597

rendering​

rendering: Rendering

Source​

packages/charts/src/specs/settings.tsx:530

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:643

resizeDebounce?​

resizeDebounce?: number

debounce delay used for resizing chart

Deprecated​

currently unused

Source​

packages/charts/src/specs/settings.tsx:581

rotation​

rotation: Rotation

Source​

packages/charts/src/specs/settings.tsx:531

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:621

showLegend​

showLegend: boolean

Show the legend

Default Value​

false

Inherited from​

LegendSpec.showLegend

Source​

packages/charts/src/specs/settings.tsx:438

specType​

specType: SpecType

The type of spec, can be series, axis, annotation, settings etc

Inherited from​

Spec.specType

Source​

packages/charts/src/specs/spec_type.ts:33

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:523

xDomain?​

xDomain?: CustomXDomain

Source​

packages/charts/src/specs/settings.tsx:571

Generated using typedoc-plugin-markdown and TypeDoc