Skip to main content

SankeyChartComponent

const SankeyChartComponent: object

Provides a component that renders a sankey chart.

Type Declaration

data()

data: () => any

Returns

any

methods

methods: object

methods._init()

_init: () => void

Returns

void

name

name: string = COMPONENT_SANKEY_CHART

props

props: object

props.className

className: object

props.className.type

type: StringConstructor = String

props.csvData

csvData: object

props.csvData.type

type: StringConstructor = String

props.data

data: object

props.data.type

type: PropType<ObjectData[]>

props.interactive

interactive: object

props.interactive.type

type: BooleanConstructor = Boolean

props.jsonData

jsonData: object

props.jsonData.type

type: PropType<VisuallyJsDefaultJSON>

props.options

options: object

props.options.type

type: PropType<Omit<SankeyOptions, "data" | "url" | "dataSourceFilter" | "dataSource">>

props.pivot

pivot: object

props.pivot.type

type: StringConstructor = String

props.url

url: object

props.url.type

type: StringConstructor = String

props.useModel

useModel: object

when present, instructs the chart to source its data from a VisuallyJs model in scope

props.useModel.default

default: boolean = false

props.useModel.type

type: BooleanConstructor = Boolean

render()

render: () => VNode<RendererNode, RendererElement, {[key: string]: any; }>

Returns

VNode<RendererNode, RendererElement, {[key: string]: any; }>

watch

watch: object

watch.options

options: object

watch.options.deep

deep: boolean = true

watch.options.handler()

handler: () => void

Returns

void

watch.csvData()

csvData(newData): void

Parameters
newData

string

Returns

void

watch.jsonData()

jsonData(newData): void

Parameters
newData

VisuallyJsDefaultJSON

Returns

void

watch.pivot()

pivot(newVal): void

Parameters
newVal

string

Returns

void

watch.url()

url(newData): void

Parameters
newData

string

Returns

void

mounted()

mounted(): void

Returns

void

setup()

setup(): object

Returns

object

service

service: unknown