summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc
blob: d3375a9020e2955e0a764d742cd78ebfb9602efe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \qmltype ColorGradientStop
    \inqmlmodule QtDataVisualization
    \since QtDataVisualization 1.0
    \ingroup datavisualization_qml
    \brief Defines the color at a position in ColorGradient.

    Defines the color at a position in a ColorGradient.

    \sa ColorGradient
*/

/*!
    \qmlproperty real ColorGradientStop::position

    The position property describes the position of this gradient stop.

    The default position is 0.0.

    \sa ColorGradient
*/

/*!
    \qmlproperty color ColorGradientStop::color

    The color property describes the color color of this gradient stop.

    The default color is black.

    \sa ColorGradient
*/

/*!
    \qmltype ColorGradient
    \inqmlmodule QtDataVisualization
    \since QtDataVisualization 1.0
    \ingroup datavisualization_qml
    \brief Defines a color gradient.

    A gradient is defined by two or more colors, which will be blended seamlessly.

    The colors are specified as a set of ColorGradientStop child items, each of
    which defines a position on the gradient from 0.0 to 1.0 and a color.
    The position of each ColorGradientStop is defined by setting its
    \l{ColorGradientStop::}{position} property; its color is defined using its
    \l{ColorGradientStop::}{color} property.

    A gradient without any gradient stops falls back to QLinearGradient default,
    which is black at 0.0 and white at 1.0.

    \sa ColorGradientStop
*/

/*!
    \qmlproperty list<ColorGradientStop> ColorGradient::stops
    \qmldefault

    This property holds the gradient stops describing the gradient.

    By default, this property contains an empty list.

    To set the gradient stops, define them as children of the ColorGradient.
*/