plotly / plotly/plotly.py

add support for stem plots

未关闭
#4,800 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

feature P3
主要语言
Python
星标
18.8k
派生
2.8k
平均合并
16 小时 26 分钟
30 天内合并 PR
21

描述

Feature Request: Add support for stem plots

Description:
The stem plot is widely used in MATLAB/Octave/Python(matplotlib.pyplot.stem) to represent discrete data with markers and stems (vertical lines) connecting the data points to the x-axis. It is particularly useful for plotting sampled signals or data that has clear separation along the x-axis.

Currently, Plotly doesn't have a built-in function to replicate the stem plot, but users can manually create similar plots using go.Scatter and adding both lines and markers.

Proposal:
Introduce a native stem plot type that:

  • Draws vertical lines from the x-axis to each data point.
  • Places a marker on each data point.
  • Allows customization of marker and line styles (similar to MATLAB).

Why it’s useful:

  • It simplifies the creation of a common plot type in scientific and engineering fields.
  • It would improve ease of use for users transitioning from MATLAB/Octave.

Examples:
Below is an example of how users can manually create a stem plot using Plotly’s go.Scatter, but it would be nice if this kind of function could be called as go.Scatter, by passing some parameter to transform in stem plot, or if we could call a function from plotly:

import plotly.graph_objects as go

# Counter for creating unique legend groups if not passed
legendgroup_cnt = 0

# Function to create a stem plot in Plotly
# x: data for the x-axis
# y: data for the y-axis (x and y must have the same number of elements)
# fig: if passed, plots on the given figure, otherwise creates a new one
# marker_symbol: allows changing the marker style (see options at https://plotly.com/python/marker-style/)
# color: the color of the marker and lines
# legendgroup: allows creating a group of legends with the same name
def stem_plot(x, y, fig=[], name='plot', color="blue", marker_symbol='circle-open', legendgroup=[]):
    global legendgroup_cnt

    # If fig is empty, create a new figure
    if fig == []:
        fig = go.Figure()

    # If legendgroup is not provided, create a new legendgroup for each curve
    if legendgroup == []:
        legendgroup = legendgroup_cnt
        legendgroup_cnt += 1

    # Create a scatter trace for markers
    scatter_trace = go.Scatter(
        x=x, y=y, mode='markers',
        marker_symbol=marker_symbol,
        marker=dict(size=14, color=color),
        name=name, legendgroup=legendgroup
    )
    fig.add_trace(scatter_trace)

    # Create a line connecting markers to the x-axis
    for xi, yi in zip(x, y):
        line_trace = go.Scatter(
            x=[xi, xi], y=[0, yi], mode='lines',
            line=dict(color=scatter_trace.marker.color),
            name=name, showlegend=False, legendgroup=legendgroup
        )
        fig.add_trace(line_trace)

    return fig

# using the function
x = np.arange(0,10,1)
y = 2*x
fig = stem_plot(x, y, fig=[], name='mystem', color="blue", marker_symbol='circle-open', legendgroup=[])
fig.show()

plot-stem

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查现有的 go.Scatter 入口点,以及 Plotly 如何表示 marker 和 line 的样式。该 issue 没有指定 repository 文件或测试,并且 API 的选择是开放的;完成标准是提供一个原生的 stem-plot 接口,将 stem 绘制到 x 轴、放置 marker,并支持 marker 和 line 的自定义。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
data-visualization
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。