@amad3v/solid-echarts - v1.0.2
    Preparing search index...

    Type Alias SolidEChartAPI

    Stable proxy for calling ECharts instance methods directly, without null checks, optional chaining, or signal unwrapping.

    Every method reads the live instance at call time. When the instance is unavailable (pre-mount, mid-reinit, post-dispose), methods return undefined and void methods silently no-op. The one exception is isDisposed, it returns true when no instance exists, which is semantically correct.

    Methods already managed by the library are intentionally excluded: setOption -> createChartEffect / option prop, setTheme -> theme prop, showLoading/hideLoading -> loading prop, resize -> autoResize / ResizeObserver, on/off -> onEvents / onSurfaceEvents, dispatchAction -> dispatch, dispose -> component lifecycle.

    useChart for how to access this object

    type SolidEChartAPI = {
        appendData: EChartFnApi<EChartsType["appendData"]>;
        clear: () => void;
        containPixel: EChartFnApi<EChartsType["containPixel"]>;
        convertFromPixel: EChartFnApi<EChartsType["convertFromPixel"]>;
        convertToLayout: EChartFnApi<EChartsType["convertToLayout"]>;
        convertToPixel: EChartFnApi<EChartsType["convertToPixel"]>;
        getConnectedDataURL: EChartFnApi<EChartsType["getConnectedDataURL"]>;
        getDataURL: EChartFnApi<EChartsType["getDataURL"]>;
        getDevicePixelRatio: () => number | undefined;
        getDom: () => HTMLElement | undefined;
        getHeight: () => number | undefined;
        getId: () => string | undefined;
        getOption: EChartFnApi<EChartsType["getOption"]>;
        getVisual: EChartFnApi<EChartsType["getVisual"]>;
        getWidth: () => number | undefined;
        isDisposed: () => boolean;
        isSSR: () => boolean;
        renderToCanvas: EChartFnApi<EChartsType["renderToCanvas"]>;
        renderToSVGString: EChartFnApi<EChartsType["renderToSVGString"]>;
    }
    Index

    Properties

    appendData clear containPixel convertFromPixel convertToLayout convertToPixel getConnectedDataURL getDataURL getDevicePixelRatio getDom getHeight getId getOption getVisual getWidth isDisposed isSSR renderToCanvas renderToSVGString

    Properties

    appendData: EChartFnApi<EChartsType["appendData"]>

    Incrementally appends data to a series without a full setOption cycle. Designed for streaming large datasets, pair with manual mode by omitting the option prop on SolidEChart.

    The coordinate system extent must be fixed in the initial setOption call, appendData does not update axis min/max ranges.

    echartsInstance.appendData [external]

    clear: () => void

    Clears all series and components without disposing the instance. The instance remains usable, call setOption afterward to render new content.

    containPixel: EChartFnApi<EChartsType["containPixel"]>

    Returns whether a pixel point falls inside a coordinate system or component.

    Target coordinate system or component.

    [x, y] pixel coordinate to test.

    convertFromPixel: EChartFnApi<EChartsType["convertFromPixel"]>

    Converts a pixel coordinate back to a data coordinate.

    echartsInstance.convertFromPixel [external]

    convertToLayout: EChartFnApi<EChartsType["convertToLayout"]>

    Converts a data value coordinate into its corresponding layout coordinate

    echartsInstance.convertToLayout [external]

    convertToPixel: EChartFnApi<EChartsType["convertToPixel"]>

    Converts a data coordinate to a pixel coordinate.

    Target coordinate system e.g. { seriesIndex: 0 }.

    Data value in the coordinate system's units.

    echartsInstance.convertToPixel [external]

    getConnectedDataURL: EChartFnApi<EChartsType["getConnectedDataURL"]>

    Exports all charts in the same group as a single combined image. Requires connect, charts must share a group via the group prop.

    getDataURL: EChartFnApi<EChartsType["getDataURL"]>

    Exports the chart as a base64 data URL.

    type ("png"|"jpeg"|"svg"), pixelRatio, backgroundColor, excludeComponents.

    getDevicePixelRatio: () => number | undefined

    Device pixel ratio used by the renderer.

    getDom: () => HTMLElement | undefined

    The container HTMLElement the chart was initialised on.

    getHeight: () => number | undefined

    Current rendered height in CSS pixels.

    getId: () => string | undefined

    The ECharts internal instance ID. Useful for debugging, logging, and cross-referencing instances, for example, identifying which chart fired an event when multiple charts share a group.

    getOption: EChartFnApi<EChartsType["getOption"]>

    The current merged ECharts option, includes ECharts' internal defaults and all setOption calls. Not the raw user option.

    getVisual: EChartFnApi<EChartsType["getVisual"]>

    Reads a computed visual property from a series or data item.

    Target series/data item.

    e.g. 'color', 'symbol', 'symbolSize'.

    getWidth: () => number | undefined

    Current rendered width in CSS pixels.

    isDisposed: () => boolean

    Whether the instance is disposed or unavailable. Returns true when no instance is available, semantically correct since a non-existent instance is not currently rendering.

    isSSR: () => boolean

    Whether the chart was initialised in server-side rendering (SSR) mode. Use to guard canvas-only operations when SSR is active.

    renderToCanvas: EChartFnApi<EChartsType["renderToCanvas"]>

    Renders the chart to an HTMLCanvasElement (canvas renderer only).

    Unlike getDataURL which converts to a base64 string, this returns the raw canvas element, useful for canvas-to-canvas compositing, loading into a WebGL texture, or passing to libraries like fabric.js.

    Throws if called on a chart using the SVG renderer.

    Optional backgroundColor and pixelRatio overrides.

    renderToSVGString: EChartFnApi<EChartsType["renderToSVGString"]>

    Renders the chart to an SVG string (SVG renderer only). Useful for SSR and server-side image generation.

    Settings

    Member Visibility

    On This Page

    Properties