Skip to content

Altair embed options to remove actions #7277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 24, 2025
Merged

Altair embed options to remove actions #7277

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
039f8d8
fix embed options
koaning Oct 28, 2025
7e6f8a7
wip
koaning Nov 4, 2025
3d47f94
Remove optional from embedOptions in VegaPlugin
koaning Nov 24, 2025
0ae0e6c
Remove spread operator for embedOptions in return
koaning Nov 24, 2025
befb438
[WIP] Fix Altair embed options to remove actions (#7285)
Copilot Nov 24, 2025
4c91db6
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 24, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions frontend/src/plugins/impl/vega/VegaPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export class VegaPlugin implements IPlugin<VegaComponentState, Data> {
.union([z.boolean(), z.literal("point"), z.literal("interval")])
.default(true),
fieldSelection: z.union([z.boolean(), z.array(z.string())]).default(true),
embedOptions: z.object({}).passthrough().default({}),
});

render(props: IPluginProps<VegaComponentState, Data>): JSX.Element {
Expand Down
24 changes: 19 additions & 5 deletions frontend/src/plugins/impl/vega/vega-component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export interface Data {
spec: VegaLiteSpec;
chartSelection: boolean | "point" | "interval";
fieldSelection: boolean | string[];
embedOptions?: Record<string, unknown>;
}

export interface VegaComponentState {
Expand Down Expand Up @@ -58,6 +59,7 @@ const VegaComponent = ({
chartSelection,
fieldSelection,
spec,
embedOptions,
}: VegaComponentProps<VegaComponentState>) => {
const { data: resolvedSpec, error } = useAsyncData(async () => {
// We try to resolve the data before passing it to Vega
Expand All @@ -82,6 +84,7 @@ const VegaComponent = ({
chartSelection={chartSelection}
fieldSelection={fieldSelection}
spec={resolvedSpec}
embedOptions={embedOptions}
/>
);
};
Expand All @@ -92,11 +95,27 @@ const LoadedVegaComponent = ({
chartSelection,
fieldSelection,
spec,
embedOptions,
}: VegaComponentProps<VegaComponentState>): JSX.Element => {
const { theme } = useTheme();
const vegaView = useRef<View>(undefined);
const [error, setError] = useState<Error>();

// Merge default actions with user-provided embed options
const actions = useMemo(() => {
// If embedOptions contains 'actions', use it directly
if (embedOptions && "actions" in embedOptions) {
return embedOptions.actions;
}

// Otherwise use defaults
return {
source: false,
compiled: false,
...embedOptions,
Copy link
Contributor

@mscolnick mscolnick Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this spread be here? i think we can just return:

{
      source: false,
      compiled: false,
}
};
}, [embedOptions]);

// Aggressively memoize the spec, so Vega doesn't re-render/re-mount the component
const specMemo = useDeepCompareMemoize(spec);
const selectableSpec = useMemo(() => {
Expand Down Expand Up @@ -242,11 +261,6 @@ const LoadedVegaComponent = ({
);
};

const actions = {
source: false,
compiled: false,
};

/**
* Convert any sets to a list before passing to the BE
*/
Expand Down
6 changes: 6 additions & 0 deletions marimo/_plugins/ui/_impl/altair_chart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,11 @@ def __init__(

import altair as alt

# Capture any global altair embed options that may have been set
embed_options = {}
if alt.renderers.options.get("embed_options"):
embed_options = alt.renderers.options["embed_options"]

register_transformers()

self._chart = chart
Expand Down Expand Up @@ -430,6 +435,7 @@ def __init__(
"spec": vega_spec,
"chart-selection": chart_selection,
"field-selection": legend_selection,
"embed-options": embed_options,
},
on_change=on_change,
)
Expand Down
Loading