Skip to content

Variable: fxLayoutAttributes ​

ts
const fxLayoutAttributes: object;

Experimental

Layout attributes of the fx component (hover labels, hover distance, click and select modes).

Type Declaration ​

NameType
clickmodeAttr< | "none" | "select" | "event" | `select+${string}` | `event+${string}`, { description: "`event` emits `click` with the points under the pointer; `select` also selects them (shift adds to the selection)."; dflt: "event"; editType: "none"; extras: readonly ["none"]; flags: readonly ["event", "select"]; }>
hoverdistanceAttr<number, { description: "Maximum distance (px) from the pointer to a point for it to be hovered. `-1` means no limit; `0` turns hover off for area-like traces only."; dflt: 20; editType: "none"; min: -1; }>
hoverlabelObjectNode<{ align: Attr<"left" | "right" | "auto", { description: "Text alignment inside labels."; dflt: "auto"; values: readonly ["left", "right", "auto"]; }>; bgcolor: Attr<string, { description: "Label background. Defaults to the point color."; }>; bordercolor: Attr<string, { description: "Label border. Defaults to a color contrasting with the background."; }>; font: ObjectNode<{ color: Attr<string, { description: "Text color."; }>; family: Attr<string, { description: "CSS font-family list."; noBlank: true; strict: true; }>; size: Attr<number, { description: "Font size in CSS pixels."; min: 1; }>; }>; grouptitlefont: ObjectNode<{ color: Attr<string, { description: "Text color."; }>; family: Attr<string, { description: "CSS font-family list."; noBlank: true; strict: true; }>; size: Attr<number, { description: "Font size in CSS pixels."; min: 1; }>; }>; namelength: Attr<number, { description: "Characters of the trace name shown (`-1`: all, `0`: none)."; dflt: 15; min: -1; }>; showarrow: Attr<boolean, { description: "Draw the arrow pointing at the point."; dflt: true; }>; }>
selectdirectionAttr<"any" | "h" | "v" | "d", { description: "Box selection direction: horizontal only (`h`), vertical only (`v`), whichever the drag started in (`d`), or free (`any`)."; dflt: "any"; editType: "none"; values: readonly ["h", "v", "d", "any"]; }>
spikedistanceAttr<number, { description: "Maximum distance (px) for spikelines (E3.10). `-1` means no limit."; dflt: -1; editType: "none"; min: -1; }>

Released under the MIT License.