Skip to content
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.

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

feat(D3 plugin): add cursor option for series #441

Merged
merged 1 commit into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

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 src/plugins/d3/renderer/hooks/useSeries/prepare-area.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ export function prepareArea(args: PrepareAreaSeriesArgs) {
allowOverlap: get(series, 'dataLabels.allowOverlap', false),
},
marker: prepareMarker(series, seriesOptions),
cursor: get(series, 'cursor', null),
};

return prepared;
Expand Down
1 change: 1 addition & 0 deletions src/plugins/d3/renderer/hooks/useSeries/prepare-bar-x.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export function prepareBarXSeries(args: PrepareBarXSeriesArgs): PreparedSeries[]
allowOverlap: series.dataLabels?.allowOverlap || false,
padding: get(series, 'dataLabels.padding', DEFAULT_DATALABELS_PADDING),
},
cursor: get(series, 'cursor', null),
};
}, []);
}
1 change: 1 addition & 0 deletions src/plugins/d3/renderer/hooks/useSeries/prepare-bar-y.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export function prepareBarYSeries(args: PrepareBarYSeriesArgs): PreparedSeries[]
stacking: series.stacking,
stackId: getSeriesStackId(series),
dataLabels: prepareDataLabels(series),
cursor: get(series, 'cursor', null),
};
}, []);
}
1 change: 1 addition & 0 deletions src/plugins/d3/renderer/hooks/useSeries/prepare-line.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ export function prepareLineSeries(args: PrepareLineSeriesArgs) {
dashStyle: dashStyle as DashStyle,
linecap: prepareLinecap(dashStyle as DashStyle, series, seriesOptions) as LineCap,
opacity: get(series, 'opacity', null),
cursor: get(series, 'cursor', null),
};

return prepared;
Expand Down
1 change: 1 addition & 0 deletions src/plugins/d3/renderer/hooks/useSeries/prepare-pie.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export function preparePieSeries(args: PreparePieSeriesArgs) {
},
renderCustomShape: series.renderCustomShape,
opacity: get(dataItem, 'opacity', null),
cursor: get(series, 'cursor', null),
};

return result;
Expand Down
1 change: 1 addition & 0 deletions src/plugins/d3/renderer/hooks/useSeries/prepare-scatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ export function prepareScatterSeries(args: PrepareScatterSeriesArgs): PreparedSc
},
data: s.data,
marker: prepareMarker(s, seriesOptions, index),
cursor: get(s, 'cursor', null),
};

return prepared;
Expand Down
5 changes: 4 additions & 1 deletion src/plugins/d3/renderer/hooks/useSeries/prepare-treemap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export function prepareTreemap(args: PrepareTreemapSeriesArgs) {
const name = s.name || '';
const color = s.color || colorScale(name);

return {
const preparedSeries: PreparedTreemapSeries = {
color,
data: s.data,
dataLabels: {
Expand All @@ -43,6 +43,9 @@ export function prepareTreemap(args: PrepareTreemapSeriesArgs) {
},
levels: s.levels,
layoutAlgorithm: get(s, 'layoutAlgorithm', LayoutAlgorithm.Binary),
cursor: get(s, 'cursor', null),
};

return preparedSeries;
});
}
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useSeries/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ type BasePreparedSeries = {
enabled: boolean;
symbol: PreparedLegendSymbol;
};
cursor: string | null;
};

export type PreparedScatterSeries = {
Expand Down Expand Up @@ -243,7 +244,7 @@ export type PreparedTreemapSeries = {
};
layoutAlgorithm: `${LayoutAlgorithm}`;
} & BasePreparedSeries &
TreemapSeries;
Omit<TreemapSeries, keyof BasePreparedSeries>;

export type PreparedSeries =
| PreparedScatterSeries
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/area/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ export const AreaSeriesShapes = (args: Args) => {
.selectAll('shape')
.data(preparedData)
.join('g')
.attr('class', b('series'));
.attr('class', b('series'))
.attr('cursor', (d) => d.series.cursor);

shapeSelection
.append('path')
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/bar-x/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export const BarXSeriesShapes = (args: Args) => {
.attr('height', (d) => d.height)
.attr('width', (d) => d.width)
.attr('fill', (d) => d.data.color || d.series.color)
.attr('opacity', (d) => d.opacity);
.attr('opacity', (d) => d.opacity)
.attr('cursor', (d) => d.series.cursor);

let dataLabels = preparedData.map((d) => d.label).filter(Boolean) as LabelData[];
if (!preparedData[0]?.series.dataLabels.allowOverlap) {
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/bar-y/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ export const BarYSeriesShapes = (args: Args) => {
.attr('height', (d) => d.height)
.attr('width', (d) => d.width)
.attr('fill', (d) => d.color)
.attr('opacity', (d) => d.data.opacity || null);
.attr('opacity', (d) => d.data.opacity || null)
.attr('cursor', (d) => d.series.cursor);

const dataLabels = preparedData.filter((d) => d.series.dataLabels.enabled);
const labelSelection = svgElement
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/line/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ export const LineSeriesShapes = (args: Args) => {
.attr('stroke-linejoin', (d) => d.linecap)
.attr('stroke-linecap', (d) => d.linecap)
.attr('stroke-dasharray', (d) => getLineDashArray(d.dashStyle, d.width))
.attr('opacity', (d) => d.opacity);
.attr('opacity', (d) => d.opacity)
.attr('cursor', (d) => d.series.cursor);

let dataLabels = preparedData.reduce((acc, d) => {
return acc.concat(d.labels);
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/pie/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ export function PieSeriesShapes(args: PreparePieSeriesArgs) {
return `translate(${x}, ${y})`;
})
.style('stroke', (pieData) => pieData.borderColor)
.style('stroke-width', (pieData) => pieData.borderWidth);
.style('stroke-width', (pieData) => pieData.borderWidth)
.attr('cursor', (pieData) => pieData.series.cursor);

// Render halo appearing outside the hovered slice
shapesSelection
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/scatter/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ export function ScatterSeriesShape(props: ScatterSeriesShapeProps) {
.join('g')
.call(renderMarker)
.attr('fill', (d) => d.point.data.color || d.point.series.color || '')
.attr('opacity', (d) => d.point.opacity);
.attr('opacity', (d) => d.point.opacity)
.attr('cursor', (d) => d.point.series.cursor);

const getSelectedPoint = (element: Element) => {
return select<BaseType, PreparedScatterData>(element).datum();
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/d3/renderer/hooks/useShapes/treemap/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ export const TreemapSeriesShape = (props: ShapeProps) => {
.selectAll('g')
.data(leaves)
.join('g')
.attr('transform', (d) => `translate(${d.x0},${d.y0})`);
.attr('transform', (d) => `translate(${d.x0},${d.y0})`)
.attr('cursor', series.cursor);
const rectSelection = leaf
.append('rect')
.attr('id', (d) => d.id || d.name)
Expand Down
2 changes: 2 additions & 0 deletions src/types/widget-data/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export type BaseSeries = {
* */
allowOverlap?: boolean;
};
/** You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. */
cursor?: string;
};

export type BaseSeriesData<T = any> = {
Expand Down
Loading