en/option/partial/mark-line.md

#${prefix} markLine(Object) Use a line in the chart to illustrate.

{{ use: partial-silent(prefix=“#” + ${prefix}) }}

##${prefix} symbol(string|Array) Symbol type at the two ends of the mark line. It can be an array for two ends, or assigned seperately. See data.symbol for more format information. ##${prefix} symbolSize(number|Array) Symbol size at the two ends of the mark line. It can be an array for two ends, or assigned seperately.

**Attention: ** You cannot assgin width and height seperately as normal symbolSize.

##${prefix} precision(number) = 2 Precison of marking line value, which is useful when displaying average value mark line.

##${prefix} label(Object) Mark line text. {{ use: mark-line-label( prefix=${prefix} + ‘##’ ) }} ###${prefix} emphasis(Object) {{ use: mark-line-label( prefix=${prefix} + ‘###’ ) }}

##${prefix} lineStyle(Object) Mark line style. {{ use: partial-line-style( prefix=“##” + ${prefix}, defaultColor=null, defaultLineType=‘dashed’, hasCurveness=true ) }} ###${prefix} emphasis(Object) {{ use: partial-line-style( prefix=“###” + ${prefix} ) }}

##${prefix} data Data array of marking line. Every array item can be an array of one or two values, representing starting and ending point of the line, and every item is an object. Here are several ways to assign the positions of starting and ending point.

Assign coordinate according to container with x, y attribute, in which pixel values and percentage are supported. {{ if: ${hasCoord} }}
Assign coordinate position with coord attribute, in which 'min', 'max', 'average' are supported for each dimension. {{ /if }}{{ if: ${hasType} }}
Use type attribute to mark the maximum and minimum values in the series, in which valueIndex or valueDim can be used to assign the dimension.
You may also create a mark line in Cartesian coordinate at a specific position in X or Y axis by assigning xAxis or yAxis. See scatter-weight for example. {{ /if }} When multiple attributes exist, priority is as the above order.

{{if: ${hasType} }} You may also set the type of mark line through type, stating whether it is for the maximum value or average value. Likewise, dimensions can be assigned through valueIndex. {{ /if }}

data: [
    {{if: ${hasType} }}{
        name: 'average line',
        // 'average', 'min', and 'max' are supported
        type: 'average'
    },
    {
        name: 'Horizontal line with Y value at 100',
        yAxis: 100
    },
    [
        {
            // Use the same name with starting and ending point
            name: 'Minimum to Maximum',
            type: 'min'
        },
        {
            type: 'max'
        }
    ],
    {{/if}}{{if: ${hasCoord} }}[
        {
            name: 'Markline between two points',
            coord: [10, 20]
        },
        {
            coord: [20, 30]
        }
    ], [{
        // Mark line with a fixed X position in starting point. This is used to generate an arrow pointing to maximum line.
        yAxis: 'max',
        x: '90%'
    }, {
        type: 'max'
    }],
    {{/if}}[
        {
            name: 'Mark line between two points',
            x: 100,
            y: 100
        },
        {
            x: 500,
            y: 200
        }
    ]
]

###${prefix} 0(Object) Data of the starting point. {{ use: mark-line-data-item-item( name=“starting point”, prefix=“###”+${prefix}, seriesType=${seriesType}, hasCoord=${hasCoord}, hasType=${hasType}, index=0 ) }}

###${prefix} 1(Object) Data of the ending point. {{ use: mark-line-data-item-item( name=“ending point”, prefix=“###”+${prefix}, seriesType=${seriesType}, hasCoord=${hasCoord}, hasType=${hasType}, index=1 ) }}

{{ use: partial-animation( prefix=“#” + ${prefix}, galleryEditorPath=${galleryEditorPath}, ) }}

{{ target: mark-line-label }} #${prefix} show(boolean) = ${defaultShowLabel|default(true)} Whether show label or not. #${prefix} position(string) = ‘end’ Positions of labels can be:

'start' starting point of the line.
'middle' middle point of the line.
'end' ending point of the line.

Since version 4.7.0, more label positions are supported: 'start', 'middle', 'end', 'insideStartTop', 'insideStartBottom', 'insideMiddleTop', 'insideMiddleBottom', 'insideEndTop', 'insideEndBottom'.

'insideMiddleBottom' is the same as 'middle'. Position is as the following chart.

The distance between labels and mark lines can be set with label.distance.

~800x500

#${prefix} distance(number|Array) The distance between labels and mark lines. If it‘s an array, then the first element is the horizontal distance, and the second element is the vertical distance. If it’s a number, then the horizontal and vertical disntances are the same.

#${prefix} formatter(string|Function) {{ use: partial-1d-data-label-formatter }}

{{ target: mark-line-data-item-item }} {{ if: ${hasType} }} #${prefix} type(string) Special label types, are used to label maximum value, minimum value and so on.

Options are:

'min' minimum value.
'max' maximum value.
'average' average value.
'median' median value. {{ /if }} {{ if: ${hasCoord} }} #${prefix} valueIndex(number) Works only when type is assigned. It is used to state the dimension used to calculate maximum value or minimum value. It may be 0 (for xAxis, or radiusAxis), or 1 (for yAxis, or angleAxis). Dimension of the first numeric axis is used by default.

#${prefix} valueDim(string) Works only when type is assigned. It is used to state the dimension used to calculate maximum value or minimum value. It may be the direct name of a dimension, like x, or angle for line charts, or open, or close for candlestick charts.

#${prefix} coord(Array) Coordinates of the starting point or ending point, whose format depends on the coordinate of the series. It can be x, and y for rectangular coordinates, or radius, and angle for polar coordinates.

#${prefix} name(string) = ‘${name}’ Name of the marker, which will display as a label.

#${prefix} x(number) X position according to container, in pixel.

#${prefix} y(number) Y position according to container, in pixel.

#${prefix} value(number) Label value, which can be ignored.

{{ use:partial-symbol( prefix=${prefix}, name=${index} === 0 ? ‘starting point’ : ‘ending point’ ) }}

#${prefix} lineStyle(Object) Line style of this data item, which will be merged with lineStyle of starting point and ending point. {{ use: partial-line-style( prefix=“#”+${prefix}, hasCurveness=true ) }} ##${prefix} emphasis(Object) {{ use: partial-line-style( prefix=“##”+${prefix}, hasCurveness=true ) }}

#${prefix} label(Object) Label of this data item, which will be merged with label of starting point and ending point. {{ use: mark-line-label( prefix=‘#’+${prefix} ) }}

#${prefix} emphasis(Object) ##${prefix} lineStyle(Object) {{ use: partial-line-style( prefix=“##”+${prefix}, hasCurveness=true ) }} ##${prefix} label(Object) {{ use: mark-line-label( prefix=‘##’+${prefix} ) }}