grafit-charts

---

Interface: ScatterSeriesOptions

Extends

• MarkerSeriesBaseOptions

Properties

fill?

optional fill?: string

Inherited from

MarkerSeriesBaseOptions.fill

---

fillOpacity?

optional fillOpacity?: number

Inherited from

MarkerSeriesBaseOptions.fillOpacity

---

id?

optional id?: string

Inherited from

MarkerSeriesBaseOptions.id

---

itemStyler?

optional itemStyler?: Styler<MarkerItemStylerParams, MarkerItemStyle>

Inherited from

MarkerSeriesBaseOptions.itemStyler

---

label?

optional label?: Switchable & FontOptions & PartLabelBlockOptions<MarkerLabelFormatterParams> & object

Point labels: the name of the point (labelField) and its value, drawn as one block — each half with its own font, layout putting the value behind a separator (default) or on a line of its own. placement hangs the block off the marker: top (by default) / bottom / left / right / inside.

Type Declaration

formatter?

optional formatter?: (params) => string

The whole label at once; it wins over category/value.

Parameters

params

datum

Datum

value

number

Returns

string

placement?

optional placement?: "top" | "right" | "bottom" | "left" | "inside"

inside — within the marker (for bubble), auto-contrast + outline.

Inherited from

MarkerSeriesBaseOptions.label

---

labelField?

optional labelField?: string

Data key of the point name — the heading of its tooltip and the name half of its label. Without it a point is only known by its coordinates.

Inherited from

MarkerSeriesBaseOptions.labelField

---

labelName?

optional labelName?: Formattable<PartNameParams>

How the value of labelField becomes text — for the tooltip heading and the name half of a point label alike. label.category overrides it where a label wants something shorter.

Inherited from

MarkerSeriesBaseOptions.labelName

---

name?

optional name?: string

Inherited from

MarkerSeriesBaseOptions.name

---

shape?

optional shape?: MarkerShape

Inherited from

MarkerSeriesBaseOptions.shape

---

showInLegend?

optional showInLegend?: boolean

Inherited from

MarkerSeriesBaseOptions.showInLegend

---

size?

optional size?: number

Inherited from

MarkerSeriesBaseOptions.size

---

stroke?

optional stroke?: string

Inherited from

MarkerSeriesBaseOptions.stroke

---

strokeWidth?

optional strokeWidth?: number

Inherited from

MarkerSeriesBaseOptions.strokeWidth

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters

params

SeriesTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

MarkerSeriesBaseOptions.tooltip

---

type

type: "scatter"

---

visible?

optional visible?: boolean

Inherited from

MarkerSeriesBaseOptions.visible

---

xField

xField: string

Inherited from

MarkerSeriesBaseOptions.xField

---

xName?

optional xName?: string

Inherited from

MarkerSeriesBaseOptions.xName

---

yField

yField: string

Inherited from

MarkerSeriesBaseOptions.yField

---

yName?

optional yName?: string

Y value name in the tooltip (yField by default).

Inherited from

MarkerSeriesBaseOptions.yName