Source code

Download source archive ↓

src/openpyxl/chart/trendline.py

1# Copyright (c) 2010-2024 openpyxl
2
3from openpyxl.descriptors.serialisable import Serialisable
4from openpyxl.descriptors import (
5    Typed,
6    String,
7    Alias
8)
9from openpyxl.descriptors.excel import ExtensionList
10from openpyxl.descriptors.nested import (
11    NestedBool,
12    NestedInteger,
13    NestedFloat,
14    NestedSet
15)
16
17from .data_source import NumFmt
18from .shapes import GraphicalProperties
19from .text import RichText, Text
20from .layout import Layout
21
22
23class TrendlineLabel(Serialisable):
24
25    tagname = "trendlineLbl"
26
27    layout = Typed(expected_type=Layout, allow_none=True)
28    tx = Typed(expected_type=Text, allow_none=True)
29    numFmt = Typed(expected_type=NumFmt, allow_none=True)
30    spPr = Typed(expected_type=GraphicalProperties, allow_none=True)
31    graphicalProperties = Alias("spPr")
32    txPr = Typed(expected_type=RichText, allow_none=True)
33    textProperties = Alias("txPr")
34    extLst = Typed(expected_type=ExtensionList, allow_none=True)
35
36    __elements__ = ('layout', 'tx', 'numFmt', 'spPr', 'txPr')
37
38    def __init__(self,
39                 layout=None,
40                 tx=None,
41                 numFmt=None,
42                 spPr=None,
43                 txPr=None,
44                 extLst=None,
45                ):
46        self.layout = layout
47        self.tx = tx
48        self.numFmt = numFmt
49        self.spPr = spPr
50        self.txPr = txPr
51
52
53class Trendline(Serialisable):
54
55    tagname = "trendline"
56
57    name = String(allow_none=True)
58    spPr = Typed(expected_type=GraphicalProperties, allow_none=True)
59    graphicalProperties = Alias('spPr')
60    trendlineType = NestedSet(values=(['exp', 'linear', 'log', 'movingAvg', 'poly', 'power']))
61    order = NestedInteger(allow_none=True)
62    period = NestedInteger(allow_none=True)
63    forward = NestedFloat(allow_none=True)
64    backward = NestedFloat(allow_none=True)
65    intercept = NestedFloat(allow_none=True)
66    dispRSqr = NestedBool(allow_none=True)
67    dispEq = NestedBool(allow_none=True)
68    trendlineLbl = Typed(expected_type=TrendlineLabel, allow_none=True)
69    extLst = Typed(expected_type=ExtensionList, allow_none=True)
70
71    __elements__ = ('spPr', 'trendlineType', 'order', 'period', 'forward',
72                    'backward', 'intercept', 'dispRSqr', 'dispEq', 'trendlineLbl')
73
74    def __init__(self,
75                 name=None,
76                 spPr=None,
77                 trendlineType='linear',
78                 order=None,
79                 period=None,
80                 forward=None,
81                 backward=None,
82                 intercept=None,
83                 dispRSqr=None,
84                 dispEq=None,
85                 trendlineLbl=None,
86                 extLst=None,
87                ):
88        self.name = name
89        self.spPr = spPr
90        self.trendlineType = trendlineType
91        self.order = order
92        self.period = period
93        self.forward = forward
94        self.backward = backward
95        self.intercept = intercept
96        self.dispRSqr = dispRSqr
97        self.dispEq = dispEq
98        self.trendlineLbl = trendlineLbl