• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * Provides the interface for the marquee attributes.
18 * @since 8
19 */
20/**
21 * Provides the interface for the marquee attributes.
22 * @form
23 * @since 9
24 */
25interface MarqueeInterface {
26  /**
27   * Create marquee.
28   * @since 8
29   */
30  /**
31   * Create marquee.
32   * @form
33   * @since 9
34   */
35  (value: { start: boolean; step?: number; loop?: number; fromStart?: boolean; src: string }): MarqueeAttribute;
36}
37
38/**
39 * Declares marquee properties.
40 * @since 8
41 */
42/**
43 * Declares marquee properties.
44 * @form
45 * @since 9
46 */
47declare class MarqueeAttribute extends CommonMethod<MarqueeAttribute> {
48  /**
49   * Set marquee font Color.
50   * @since 8
51   */
52  /**
53   * Set marquee font Color.
54   * @form
55   * @since 9
56   */
57  fontColor(value: ResourceColor): MarqueeAttribute;
58
59  /**
60   * Set marquee font size.
61   * @since 8
62   */
63  /**
64   * Set marquee font size.
65   * @form
66   * @since 9
67   */
68  fontSize(value: Length): MarqueeAttribute;
69
70  /**
71   * Set marquee allow scale.
72   * @since 8
73   */
74  /**
75   * Set marquee allow scale.
76   * @form
77   * @since 9
78   */
79  allowScale(value: boolean): MarqueeAttribute;
80
81  /**
82   * Set marquee font weight.
83   * @since 8
84   */
85  /**
86   * Set marquee font weight.
87   * @form
88   * @since 9
89   */
90  fontWeight(value: number | FontWeight | string): MarqueeAttribute;
91
92  /**
93   * Set marquee font family.
94   * @since 8
95   */
96  /**
97   * Set marquee font family.
98   * @form
99   * @since 9
100   */
101  fontFamily(value: string | Resource): MarqueeAttribute;
102
103  /**
104   * Called when scrolling starts.
105   * @since 8
106   */
107  /**
108   * Called when scrolling starts.
109   * @form
110   * @since 9
111   */
112  onStart(event: () => void): MarqueeAttribute;
113
114  /**
115   * Called when scrolling to the bottom.
116   * @since 8
117   */
118  /**
119   * Called when scrolling to the bottom.
120   * @form
121   * @since 9
122   */
123  onBounce(event: () => void): MarqueeAttribute;
124
125  /**
126   * Called when scrolling is complete.
127   * @since 8
128   */
129  /**
130   * Called when scrolling is complete.
131   * @form
132   * @since 9
133   */
134  onFinish(event: () => void): MarqueeAttribute;
135}
136
137/**
138 * Defines Marquee Component.
139 * @since 8
140 */
141/**
142 * Defines Marquee Component.
143 * @form
144 * @since 9
145 */
146declare const Marquee: MarqueeInterface;
147
148/**
149 * Defines Marquee Component instance.
150 * @since 8
151 */
152/**
153 * Defines Marquee Component instance.
154 * @form
155 * @since 9
156 */
157declare const MarqueeInstance: MarqueeAttribute;
158