> ## Documentation Index
> Fetch the complete documentation index at: https://anvil.servicetitan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Chart Component

> Implement the Chart component from @servicetitan/anvil2-charts-kit.

export const LiveCode = ({children, customHeight, clickToLoad, example, fullWidth, fullHeight, hideCodeInLiveCode, screenshot, screenshotOnly, showCode: showCodeProp}) => {
  const SCREENSHOTS_BASE = "https://servicetitan.github.io/anvil2-docs-live-code/screenshots";
  const STACKBLITZ_BASE = "https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples";
  const [showCodeBlock, setShowCodeBlock] = useState(showCodeProp ?? false);
  const [isLocalOverride, setIsLocalOverride] = useState(false);
  useEffect(() => {
    const examplePath = `/images/live-code-screenshots-tmp/${example}.png`;
    fetch(examplePath, {
      method: "HEAD"
    }).then(r => {
      if (r.ok) setIsLocalOverride(true);
    }).catch(() => {});
  }, [example]);
  const screenshotBase = isLocalOverride ? "/images/live-code-screenshots-tmp" : SCREENSHOTS_BASE;
  if (screenshotOnly) {
    return <Frame className="flex flex-col">
        <div className="flex dark:hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#FFFFFF"
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>
        <div className="hidden dark:flex" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#141414"
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>
      </Frame>;
  }
  if (screenshot) {
    return <Frame className="flex flex-col -mb-2">
        <div className="flex dark:hidden bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>

        <div className="hidden dark:flex bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      background: "#141414",
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>

        <div className="flex justify-end items-center text-xs py-2 px-1 gap-4">
          {!showCodeProp ? <button className="inline-flex justify-end items-center text-gray-700 dark:text-gray-50 hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1 cursor-pointer" onClick={() => setShowCodeBlock(!showCodeBlock)} style={{
      appearance: "none"
    }}>
              <Icon icon="code" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
              <span>{showCodeBlock ? "Hide code" : "Show code"}</span>
            </button> : null}

          <a className="inline-flex justify-end items-center hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1" href={`${STACKBLITZ_BASE}/${example}?file=src/App.tsx`} target="_blank" rel="noreferrer">
            <Icon icon="bolt" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
            <span>StackBlitz demo</span>
          </a>
        </div>

        <div className="grid transition-[grid-template-rows] duration-300 ease-in-out overflow-auto overflow-y-hidden overflow-x-auto" style={showCodeBlock ? {
      gridTemplateRows: "1fr"
    } : {
      gridTemplateRows: "0fr"
    }}>
          <div style={{
      minHeight: 0,
      overflowX: "auto",
      overflowY: "hidden",
      marginBlockStart: "-1.25rem",
      marginBlockEnd: "-1.5rem"
    }}>
            {children}
          </div>
        </div>
      </Frame>;
  } else {
    return <div style={{
      display: "flex",
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px",
      resize: "vertical",
      overflow: "auto"
    }}>
        <iframe title={example} style={{
      flex: 1,
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px"
    }} src={`${STACKBLITZ_BASE}/${example}?embed=1&hideNavigation=1&hideExplorer=1&terminalHeight=0&file=src/App.tsx${clickToLoad ? "&ctl=1" : ""}${hideCodeInLiveCode ? "&view=preview" : ""}`} allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking" sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts" />
      </div>;
  }
};

<Tabs>
  <Tab title="Implementation">
    <LiveCode showCode example="charts-react-minimal" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Chart, type EChartsOption } from "@servicetitan/anvil2-charts-kit";
      import "@servicetitan/anvil2-charts-kit/styles.css";

      function App() {
        const option: EChartsOption = {
          xAxis: { type: "category", data: ["North", "South", "East", "West"] },
          yAxis: { type: "value" },
          series: [{ type: "bar", data: [1200, 980, 1450, 1100] }],
        };

        return <Chart option={option} width={480} height={300} />;
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    The `Chart` component renders an ECharts option with Anvil2 styling. Import `EChartsOption` from the kit to keep chart configuration on the supported public API.

    ```tsx theme={null}
    import {
      Chart,
      type EChartsOption,
    } from "@servicetitan/anvil2-charts-kit";
    import "@servicetitan/anvil2-charts-kit/styles.css";

    const option: EChartsOption = {
      xAxis: { type: "category", data: ["North", "South", "East", "West"] },
      yAxis: { type: "value" },
      series: [{ type: "bar", data: [1200, 980, 1450, 1100] }],
    };

    function ExampleComponent() {
      return <Chart option={option} />;
    }
    ```

    `Chart` defaults to `appearance="light"` and `variant="monochrome"`. Set `appearance` to match the surrounding theme.

    ## Tooltips

    Pass `renderTooltip` to provide tooltip content. The chart controls placement and keeps the tooltip within the plot.

    <LiveCode showCode example="charts-react-tooltip" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import {
        Chart,
        type ChartTooltipInfo,
        type EChartsOption,
      } from "@servicetitan/anvil2-charts-kit";
      import "@servicetitan/anvil2-charts-kit/styles.css";
      import { CartoTheme, Text, TooltipSurface } from "@servicetitan/anvil2-ai-kit";
      // This file is most likely already in your workspace
      import "@servicetitan/anvil2-ai-kit/styles.css";

      function renderTooltip({ name, points }: ChartTooltipInfo) {
        return (
          <TooltipSurface
            content={
              <>
                <Text text={name} />
                {points.map((point) => (
                  <Text
                    key={point.seriesIndex}
                    text={`${point.seriesName ? `${point.seriesName}: ` : ""}${String(point.value)}`}
                  />
                ))}
              </>
            }
          />
        );
      }

      function App() {
        const option: EChartsOption = {
          grid: { left: 48, right: 16, top: 24, bottom: 32 },
          xAxis: { type: "category", data: ["North", "South", "East", "West"] },
          yAxis: { type: "value" },
          series: [{ type: "bar", data: [1200, 980, 1450, 1100] }],
        };

        return (
          <CartoTheme>
            <Chart
              option={option}
              variant="monochrome"
              renderTooltip={renderTooltip}
              width={480}
              height={300}
            />
          </CartoTheme>
        );
      }

      export default App;
      ```
    </LiveCode>

    Omit `renderTooltip` when the chart does not need a tooltip. Format each `value` for its product context.

    ## Palette utilities

    Use `variant` when colors follow the palette's index order. The variant applies fills, borders, patterns, markers, corner treatments, and hover behavior.

    ```tsx theme={null}
    <Chart option={option} variant="categorical" />
    ```

    Use `chartPalette` when an option needs a specific palette entry. `chartStepItemStyle` converts monochrome and semantic steps into ECharts `itemStyle` values.

    ```tsx theme={null}
    import {
      chartPalette,
      chartStepItemStyle,
    } from "@servicetitan/anvil2-charts-kit";

    const palette = chartPalette("light", "semantic");

    const option: EChartsOption = {
      series: [
        {
          type: "bar",
          data: [1200],
          itemStyle: chartStepItemStyle(palette.danger.primary),
        },
      ],
    };
    ```

    Consumer-defined `itemStyle` values override variant styling.

    **Agent guidance**

    * Define chart structure and data in the ECharts `option`.
    * Import `EChartsOption`, chart types, and palette utilities from `@servicetitan/anvil2-charts-kit`.
    * Use `variant` when colors follow palette order.
    * Use `chartPalette` and `chartStepItemStyle` only when the option requires a specific palette entry.
    * Do not hard-code Anvil colors, borders, decals, marker shapes, or bar radii.
    * Do not add an ECharts `tooltip` block. Use `renderTooltip`.
    * Return tooltip content only. The chart controls tooltip placement.
    * Supported series are bar, line, area, pie, and donut. Registered series can be combined in one option.
  </Tab>

  <Tab title="Chart Props">
    ```tsx theme={null}
    <Chart
      option={option}
      variant="monochrome"
      width={480}
      height={300}
    />
    ```

    ## `Chart` Props

    <ParamField path="option" type="EChartsOption" required>
      Defines chart structure and data.
    </ParamField>

    <ParamField path="appearance" type={`"light" | "dark"`} default="light">
      Sets the token appearance used by the chart theme.
    </ParamField>

    <ParamField path="className" type="string">
      Applies sizing or layout styles that pixel dimensions cannot express. `width` and `height` take precedence.
    </ParamField>

    <ParamField path="height" type="number">
      Sets an explicit height in pixels. The fluid default uses the parent height or a 300px minimum.
    </ParamField>

    <ParamField path="renderTooltip" type="(info: ChartTooltipInfo) => ReactNode">
      Renders content for the active data point.
    </ParamField>

    <ParamField path="theme" type="string | object">
      Replaces the chart theme with a registered theme name or inline theme object.
    </ParamField>

    <ParamField path="variant" type={`"monochrome" | "categorical"`} default="monochrome">
      Applies an index-ordered palette and chart treatment.
    </ParamField>

    <ParamField path="width" type="number">
      Sets an explicit width in pixels. The fluid default fills the container width.
    </ParamField>
  </Tab>

  <Tab title="Tooltip Config">
    ```tsx theme={null}
    import type { ChartTooltipInfo } from "@servicetitan/anvil2-charts-kit";
    ```

    ## `ChartTooltipInfo`

    `renderTooltip` receives the active category and its data points.

    <ParamField path="name" type="string" required>
      Identifies the active category or donut slice.
    </ParamField>

    <ParamField path="points" type="ChartTooltipPoint[]" required>
      Contains the active data point for each applicable series.
    </ParamField>
  </Tab>

  <Tab title="Tooltip Point Config">
    ```tsx theme={null}
    import type { ChartTooltipPoint } from "@servicetitan/anvil2-charts-kit";
    ```

    ## `ChartTooltipPoint`

    `ChartTooltipPoint` describes one series value in a tooltip.

    <ParamField path="color" type="string | undefined" required>
      Provides the resolved color when the chart can represent it as a swatch.
    </ParamField>

    <ParamField path="dataIndex" type="number" required>
      Identifies the value within the series data.
    </ParamField>

    <ParamField path="seriesIndex" type="number" required>
      Identifies the series within `option.series`.
    </ParamField>

    <ParamField path="seriesName" type="string | undefined" required>
      Provides the series `name` when defined.
    </ParamField>

    <ParamField path="value" type="unknown" required>
      Provides the datum value for product-specific formatting.
    </ParamField>
  </Tab>
</Tabs>