Skip to content

Commit

Permalink
chore: format comments (#401)
Browse files Browse the repository at this point in the history
  • Loading branch information
Koooooo-7 committed Feb 10, 2024
1 parent 7fbb77b commit f03405a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
1 change: 0 additions & 1 deletion charts/series.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ type SingleSeries struct {
Detail *opts.Detail `json:"detail,omitempty"`
Title *opts.Title `json:"title,omitempty"`

// Shared below =====================================================
Large types.Bool `json:"large,omitempty"`
LargeThreshold int `json:"largeThreshold,omitempty"`
HoverLayerThreshold int `json:"hoverLayerThreshold,omitempty"`
Expand Down
3 changes: 1 addition & 2 deletions opts/charts.go
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ type KlineData struct {
Value interface{} `json:"value,omitempty"`
}

// LineChart is the options set for a chandlestick chart.
// KlineChart is the options set for a chandlestick chart.
// https://echarts.apache.org/en/option.html#series-candlestick
type KlineChart struct {
// Specify bar width. Absolute value (like 10) or percentage (like '20%', according to band width) can be used. Auto adapt by default.
Expand Down Expand Up @@ -445,7 +445,6 @@ type WordCloudChart struct {
RotationRange []float32
}

// WordCloudData
type WordCloudData struct {
// Name of data item.
Name string `json:"name,omitempty"`
Expand Down
6 changes: 3 additions & 3 deletions opts/series.go
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ type AreaStyle struct {
Opacity float32 `json:"opacity,omitempty"`
}

// Configuration items about force-directed layout. Force-directed layout simulates
// GraphForce Configuration items about force-directed layout. Force-directed layout simulates
// spring/charge model, which will add a repulsion between 2 nodes and add a attraction
// between 2 nodes of each edge. In each iteration nodes will move under the effect
// of repulsion and attraction. After several iterations, the nodes will be static in a
Expand Down Expand Up @@ -480,7 +480,7 @@ type GraphForce struct {
EdgeLength float32 `json:"edgeLength,omitempty"`
}

// Leaf node special configuration, the leaf node and non-leaf node label location is different.
// TreeLeaves Leaf node special configuration, the leaf node and non-leaf node label location is different.
type TreeLeaves struct {
// The style setting of the text label in a single bar.
Label *Label `json:"label,omitempty"`
Expand Down Expand Up @@ -695,7 +695,7 @@ type EdgeLabel struct {
Formatter string `json:"formatter,omitempty"`
}

// Define what is encoded to for each dimension of data
// Encode Define what is encoded to for each dimension of data
// https://echarts.apache.org/en/option.html#series-candlestick.encode
type Encode struct {
X interface{} `json:"x"`
Expand Down
3 changes: 2 additions & 1 deletion opts/title.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,9 @@ type Title struct {
// FYI, use [1] is same to number 1
BorderRadius []int `json:"borderRadius,omitempty"`

// Gauge
// Value position relative to the center of chart
// OffceCenter is provided as [x, y] where x and y are either a number (px, provided
// OffsetCenter is provided as [x, y] where x and y are either a number (px, provided
// as string) or a percentage.
// Positive values move the chart value to [right, bottom], negative values vice
// versa.
Expand Down

0 comments on commit f03405a

Please sign in to comment.