Class: Google::Cloud::Monitoring::Dashboard::V1::Text

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/dashboard/v1/text.rb

Overview

A widget that displays textual content.

Defined Under Namespace

Modules: Format Classes: TextStyle

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ ::String

Returns The text content to be displayed.

Returns:

  • (::String) —

    The text content to be displayed.



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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/monitoring/dashboard/v1/text.rb', line 35

class Text
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Properties that determine how the title and content are styled
  # @!attribute [rw] background_color
  #   @return [::String]
  #     The background color as a hex string. "#RRGGBB" or "#RGB"
  # @!attribute [rw] text_color
  #   @return [::String]
  #     The text color as a hex string. "#RRGGBB" or "#RGB"
  # @!attribute [rw] horizontal_alignment
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::HorizontalAlignment]
  #     The horizontal alignment of both the title and content
  # @!attribute [rw] vertical_alignment
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::VerticalAlignment]
  #     The vertical alignment of both the title and content
  # @!attribute [rw] padding
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::PaddingSize]
  #     The amount of padding around the widget
  # @!attribute [rw] font_size
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::FontSize]
  #     Font sizes for both the title and content. The title will still be larger
  #     relative to the content.
  # @!attribute [rw] pointer_location
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::PointerLocation]
  #     The pointer location for this widget (also sometimes called a "tail")
  class TextStyle
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The horizontal alignment of both the title and content on a text widget
    module HorizontalAlignment
      # No horizontal alignment specified, will default to H_LEFT
      HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0

      # Left-align
      H_LEFT = 1

      # Center-align
      H_CENTER = 2

      # Right-align
      H_RIGHT = 3
    end

    # The vertical alignment of both the title and content on a text widget
    module VerticalAlignment
      # No vertical alignment specified, will default to V_TOP
      VERTICAL_ALIGNMENT_UNSPECIFIED = 0

      # Top-align
      V_TOP = 1

      # Center-align
      V_CENTER = 2

      # Bottom-align
      V_BOTTOM = 3
    end

    # Specifies padding size around a text widget
    module PaddingSize
      # No padding size specified, will default to P_EXTRA_SMALL
      PADDING_SIZE_UNSPECIFIED = 0

      # Extra small padding
      P_EXTRA_SMALL = 1

      # Small padding
      P_SMALL = 2

      # Medium padding
      P_MEDIUM = 3

      # Large padding
      P_LARGE = 4

      # Extra large padding
      P_EXTRA_LARGE = 5
    end

    # Specifies a font size for the title and content of a text widget
    module FontSize
      # No font size specified, will default to FS_LARGE
      FONT_SIZE_UNSPECIFIED = 0

      # Extra small font size
      FS_EXTRA_SMALL = 1

      # Small font size
      FS_SMALL = 2

      # Medium font size
      FS_MEDIUM = 3

      # Large font size
      FS_LARGE = 4

      # Extra large font size
      FS_EXTRA_LARGE = 5
    end

    # Specifies where a visual pointer is placed on a text widget (also
    # sometimes called a "tail")
    module PointerLocation
      # No visual pointer
      POINTER_LOCATION_UNSPECIFIED = 0

      # Placed in the middle of the top of the widget
      PL_TOP = 1

      # Placed in the middle of the right side of the widget
      PL_RIGHT = 2

      # Placed in the middle of the bottom of the widget
      PL_BOTTOM = 3

      # Placed in the middle of the left side of the widget
      PL_LEFT = 4

      # Placed on the left side of the top of the widget
      PL_TOP_LEFT = 5

      # Placed on the right side of the top of the widget
      PL_TOP_RIGHT = 6

      # Placed on the top of the right side of the widget
      PL_RIGHT_TOP = 7

      # Placed on the bottom of the right side of the widget
      PL_RIGHT_BOTTOM = 8

      # Placed on the right side of the bottom of the widget
      PL_BOTTOM_RIGHT = 9

      # Placed on the left side of the bottom of the widget
      PL_BOTTOM_LEFT = 10

      # Placed on the bottom of the left side of the widget
      PL_LEFT_BOTTOM = 11

      # Placed on the top of the left side of the widget
      PL_LEFT_TOP = 12
    end
  end

  # The format type of the text content.
  module Format
    # Format is unspecified. Defaults to MARKDOWN.
    FORMAT_UNSPECIFIED = 0

    # The text contains Markdown formatting.
    MARKDOWN = 1

    # The text contains no special formatting.
    RAW = 2
  end
end

#format ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Text::Format

Returns How the text content is formatted.

Returns:



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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/monitoring/dashboard/v1/text.rb', line 35

class Text
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Properties that determine how the title and content are styled
  # @!attribute [rw] background_color
  #   @return [::String]
  #     The background color as a hex string. "#RRGGBB" or "#RGB"
  # @!attribute [rw] text_color
  #   @return [::String]
  #     The text color as a hex string. "#RRGGBB" or "#RGB"
  # @!attribute [rw] horizontal_alignment
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::HorizontalAlignment]
  #     The horizontal alignment of both the title and content
  # @!attribute [rw] vertical_alignment
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::VerticalAlignment]
  #     The vertical alignment of both the title and content
  # @!attribute [rw] padding
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::PaddingSize]
  #     The amount of padding around the widget
  # @!attribute [rw] font_size
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::FontSize]
  #     Font sizes for both the title and content. The title will still be larger
  #     relative to the content.
  # @!attribute [rw] pointer_location
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::PointerLocation]
  #     The pointer location for this widget (also sometimes called a "tail")
  class TextStyle
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The horizontal alignment of both the title and content on a text widget
    module HorizontalAlignment
      # No horizontal alignment specified, will default to H_LEFT
      HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0

      # Left-align
      H_LEFT = 1

      # Center-align
      H_CENTER = 2

      # Right-align
      H_RIGHT = 3
    end

    # The vertical alignment of both the title and content on a text widget
    module VerticalAlignment
      # No vertical alignment specified, will default to V_TOP
      VERTICAL_ALIGNMENT_UNSPECIFIED = 0

      # Top-align
      V_TOP = 1

      # Center-align
      V_CENTER = 2

      # Bottom-align
      V_BOTTOM = 3
    end

    # Specifies padding size around a text widget
    module PaddingSize
      # No padding size specified, will default to P_EXTRA_SMALL
      PADDING_SIZE_UNSPECIFIED = 0

      # Extra small padding
      P_EXTRA_SMALL = 1

      # Small padding
      P_SMALL = 2

      # Medium padding
      P_MEDIUM = 3

      # Large padding
      P_LARGE = 4

      # Extra large padding
      P_EXTRA_LARGE = 5
    end

    # Specifies a font size for the title and content of a text widget
    module FontSize
      # No font size specified, will default to FS_LARGE
      FONT_SIZE_UNSPECIFIED = 0

      # Extra small font size
      FS_EXTRA_SMALL = 1

      # Small font size
      FS_SMALL = 2

      # Medium font size
      FS_MEDIUM = 3

      # Large font size
      FS_LARGE = 4

      # Extra large font size
      FS_EXTRA_LARGE = 5
    end

    # Specifies where a visual pointer is placed on a text widget (also
    # sometimes called a "tail")
    module PointerLocation
      # No visual pointer
      POINTER_LOCATION_UNSPECIFIED = 0

      # Placed in the middle of the top of the widget
      PL_TOP = 1

      # Placed in the middle of the right side of the widget
      PL_RIGHT = 2

      # Placed in the middle of the bottom of the widget
      PL_BOTTOM = 3

      # Placed in the middle of the left side of the widget
      PL_LEFT = 4

      # Placed on the left side of the top of the widget
      PL_TOP_LEFT = 5

      # Placed on the right side of the top of the widget
      PL_TOP_RIGHT = 6

      # Placed on the top of the right side of the widget
      PL_RIGHT_TOP = 7

      # Placed on the bottom of the right side of the widget
      PL_RIGHT_BOTTOM = 8

      # Placed on the right side of the bottom of the widget
      PL_BOTTOM_RIGHT = 9

      # Placed on the left side of the bottom of the widget
      PL_BOTTOM_LEFT = 10

      # Placed on the bottom of the left side of the widget
      PL_LEFT_BOTTOM = 11

      # Placed on the top of the left side of the widget
      PL_LEFT_TOP = 12
    end
  end

  # The format type of the text content.
  module Format
    # Format is unspecified. Defaults to MARKDOWN.
    FORMAT_UNSPECIFIED = 0

    # The text contains Markdown formatting.
    MARKDOWN = 1

    # The text contains no special formatting.
    RAW = 2
  end
end

#style ⇒ ::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle

Returns How the text is styled.

Returns:



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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'proto_docs/google/monitoring/dashboard/v1/text.rb', line 35

class Text
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Properties that determine how the title and content are styled
  # @!attribute [rw] background_color
  #   @return [::String]
  #     The background color as a hex string. "#RRGGBB" or "#RGB"
  # @!attribute [rw] text_color
  #   @return [::String]
  #     The text color as a hex string. "#RRGGBB" or "#RGB"
  # @!attribute [rw] horizontal_alignment
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::HorizontalAlignment]
  #     The horizontal alignment of both the title and content
  # @!attribute [rw] vertical_alignment
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::VerticalAlignment]
  #     The vertical alignment of both the title and content
  # @!attribute [rw] padding
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::PaddingSize]
  #     The amount of padding around the widget
  # @!attribute [rw] font_size
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::FontSize]
  #     Font sizes for both the title and content. The title will still be larger
  #     relative to the content.
  # @!attribute [rw] pointer_location
  #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Text::TextStyle::PointerLocation]
  #     The pointer location for this widget (also sometimes called a "tail")
  class TextStyle
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The horizontal alignment of both the title and content on a text widget
    module HorizontalAlignment
      # No horizontal alignment specified, will default to H_LEFT
      HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0

      # Left-align
      H_LEFT = 1

      # Center-align
      H_CENTER = 2

      # Right-align
      H_RIGHT = 3
    end

    # The vertical alignment of both the title and content on a text widget
    module VerticalAlignment
      # No vertical alignment specified, will default to V_TOP
      VERTICAL_ALIGNMENT_UNSPECIFIED = 0

      # Top-align
      V_TOP = 1

      # Center-align
      V_CENTER = 2

      # Bottom-align
      V_BOTTOM = 3
    end

    # Specifies padding size around a text widget
    module PaddingSize
      # No padding size specified, will default to P_EXTRA_SMALL
      PADDING_SIZE_UNSPECIFIED = 0

      # Extra small padding
      P_EXTRA_SMALL = 1

      # Small padding
      P_SMALL = 2

      # Medium padding
      P_MEDIUM = 3

      # Large padding
      P_LARGE = 4

      # Extra large padding
      P_EXTRA_LARGE = 5
    end

    # Specifies a font size for the title and content of a text widget
    module FontSize
      # No font size specified, will default to FS_LARGE
      FONT_SIZE_UNSPECIFIED = 0

      # Extra small font size
      FS_EXTRA_SMALL = 1

      # Small font size
      FS_SMALL = 2

      # Medium font size
      FS_MEDIUM = 3

      # Large font size
      FS_LARGE = 4

      # Extra large font size
      FS_EXTRA_LARGE = 5
    end

    # Specifies where a visual pointer is placed on a text widget (also
    # sometimes called a "tail")
    module PointerLocation
      # No visual pointer
      POINTER_LOCATION_UNSPECIFIED = 0

      # Placed in the middle of the top of the widget
      PL_TOP = 1

      # Placed in the middle of the right side of the widget
      PL_RIGHT = 2

      # Placed in the middle of the bottom of the widget
      PL_BOTTOM = 3

      # Placed in the middle of the left side of the widget
      PL_LEFT = 4

      # Placed on the left side of the top of the widget
      PL_TOP_LEFT = 5

      # Placed on the right side of the top of the widget
      PL_TOP_RIGHT = 6

      # Placed on the top of the right side of the widget
      PL_RIGHT_TOP = 7

      # Placed on the bottom of the right side of the widget
      PL_RIGHT_BOTTOM = 8

      # Placed on the right side of the bottom of the widget
      PL_BOTTOM_RIGHT = 9

      # Placed on the left side of the bottom of the widget
      PL_BOTTOM_LEFT = 10

      # Placed on the bottom of the left side of the widget
      PL_LEFT_BOTTOM = 11

      # Placed on the top of the left side of the widget
      PL_LEFT_TOP = 12
    end
  end

  # The format type of the text content.
  module Format
    # Format is unspecified. Defaults to MARKDOWN.
    FORMAT_UNSPECIFIED = 0

    # The text contains Markdown formatting.
    MARKDOWN = 1

    # The text contains no special formatting.
    RAW = 2
  end
end