Collection of Popup enumerations. More...
| Header: | #include <PopupTypes.h> |
Types
| enum class | ChartImageStyle { Neutral, Light, Dark } |
| enum class | FeatureTypeChangeMode { ResetToDefaults, KeepValues } |
| enum class | PopupAttachmentEditState { Original, Added, Deleted, Unknown } |
| enum class | PopupAttachmentType { Image, Video, Document, Other } |
| enum class | PopupAttachmentsDisplayType { List, Preview, Auto } |
| enum class | PopupDateFormat { DayShortMonthYear, LongDate, LongMonthDayYear, LongMonthYear, ShortDate, …, Unknown } |
| enum class | PopupElementType { Unknown, TextPopupElement, FieldsPopupElement, MediaPopupElement, AttachmentsPopupElement, …, UnsupportedPopupElement } |
| enum class | PopupErrorCode { InvalidGeoElement, NullNotAllowed, ValueOutOfRange, ExceedsMaxLength, IllegalDomainCode, ContingencyValidationFailure } |
| enum class | PopupExpressionReturnType { String, Number, Dictionary } |
| enum class | PopupMediaType { Image, BarChart, ColumnChart, LineChart, PieChart, Unknown } |
| enum class | PopupStringFieldOption { SingleLine, MultiLine, RichText, Unknown } |
Detailed Description
Type Documentation
[since Esri::ArcGISRuntime 200.3] enum class ChartImageStyle
Enumerates the style used to generate a ChartImage.
The background of the generated chart being transparent, the chart image style controls only the text color and the line colors.
ChartImageStyle can be one of:
| Constant | Value | Description |
|---|---|---|
ChartImageStyle::Neutral | 0 | The neutral style that can be used with light or dark themes. With this style, the text color and line colors are compatible with dark and light themes. |
ChartImageStyle::Light | 1 | The light style. |
ChartImageStyle::Dark | 2 | The dark style. |
This enum was introduced or modified in Esri::ArcGISRuntime 200.3.
[since Esri::ArcGISRuntime 100.0] enum class FeatureTypeChangeMode
Enumerates the feature type change modes in a Popup.
FeatureTypeChangeMode can be one of:
| Constant | Value | Description |
|---|---|---|
FeatureTypeChangeMode::ResetToDefaults | 0 | Resets all fields to the default values defined in the feature template prototype. |
FeatureTypeChangeMode::KeepValues | 1 | Keeps all applicable current field values. If the value is not allowed in the new feature type, then it will be set to null. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0] enum class PopupAttachmentEditState
Enumerates the attachment edit state of the Popup.
PopupAttachmentEditState can be one of:
| Constant | Value | Description |
|---|---|---|
PopupAttachmentEditState::Original | 0 | Attachments that already existed on the GeoElement and have not been deleted are considered original. |
PopupAttachmentEditState::Added | 1 | Attachments that have been provided via a URL or directly via data and then added to a GeoElement are considered added. |
PopupAttachmentEditState::Deleted | 2 | Attachments that existed on the GeoElement but have been removed are considered deleted. |
PopupAttachmentEditState::Unknown | -1 | An unknown attachment state. New value since 200.3. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0] enum class PopupAttachmentType
Enumerates the type of attachment in a PopupAttachmentManager.
PopupAttachmentType can be one of:
| Constant | Value | Description |
|---|---|---|
PopupAttachmentType::Image | 0 | An image. |
PopupAttachmentType::Video | 1 | A video. |
PopupAttachmentType::Document | 2 | A document. |
PopupAttachmentType::Other | 3 | An attachment of another type. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.14] enum class PopupAttachmentsDisplayType
Indicates how to display the attachments. If `list` is specified, attachments show as links. If `preview` is specified, attachments expand to the width of the pop-up. Setting the value to `auto` allows applications to choose the most suitable default experience for their application.
The PopupAttachmentsDisplayType can be one of:
| Constant | Value | Description |
|---|---|---|
PopupAttachmentsDisplayType::List | 0 | Show attachments as links. |
PopupAttachmentsDisplayType::Preview | 1 | Attachments expand to the width of the pop-up. |
PopupAttachmentsDisplayType::Auto | 2 | Allows applications to choose the most suitable default experience for their application. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.14.
[since Esri::ArcGISRuntime 100.0] enum class PopupDateFormat
Format of a date field in a pop-up.
Controls how a date field is displayed a pop-up. All provided examples are localized to en-US.
PopupDateFormat can be one of:
| Constant | Value | Description |
|---|---|---|
PopupDateFormat::DayShortMonthYear | 0 | Example: Dec 30, 1997 |
PopupDateFormat::LongDate | 1 | Example: Tuesday, December 30, 1997 |
PopupDateFormat::LongMonthDayYear | 2 | Example: December 30, 1997 |
PopupDateFormat::LongMonthYear | 3 | Example: December 1997 |
PopupDateFormat::ShortDate | 4 | Example: 12/30/1997 |
PopupDateFormat::ShortDateLE | 5 | Example: 30/12/1997 |
PopupDateFormat::ShortDateLELongTime | 6 | Example: 30/12/1997 5:59:59 PM |
PopupDateFormat::ShortDateLELongTime24 | 7 | Example: 30/12/1997 17:59:59 |
PopupDateFormat::ShortDateLEShortTime | 8 | Example: 30/12/1997 6:00 PM |
PopupDateFormat::ShortDateLEShortTime24 | 9 | Example: 30/12/1997 18:00 |
PopupDateFormat::ShortDateLongTime | 10 | Example: 12/30/1997 5:59:59 PM |
PopupDateFormat::ShortDateLongTime24 | 11 | Example: 12/30/1997 17:59:59 |
PopupDateFormat::ShortDateShortTime | 12 | Example: 12/30/1997 6:00 PM |
PopupDateFormat::ShortDateShortTime24 | 13 | Example: 12/30/1997 18:00 |
PopupDateFormat::ShortMonthYear | 14 | Example: Dec 1997 |
PopupDateFormat::Year | 15 | Example: 1997 |
PopupDateFormat::DayShortMonthYearLongTime | 16 | Example: Dec 30, 1997, 5:32:10 PM. |
PopupDateFormat::DayShortMonthYearLongTime24 | 17 | Example: Dec 30, 1997, 17:32:10. |
PopupDateFormat::DayShortMonthYearShortTime | 18 | Example: Dec 30, 1997, 6:00 PM. |
PopupDateFormat::DayShortMonthYearShortTime24 | 19 | Example: Dec 30, 1997, 17:32. |
PopupDateFormat::LongDateLongTime | 20 | Example: Tuesday, December 30, 1997, 5:32:10 PM. |
PopupDateFormat::LongDateLongTime24 | 21 | Example: Tuesday, December 30, 1997, 17:32:10. |
PopupDateFormat::LongDateShortTime | 22 | Example: Tuesday, December 30, 1997, 6:00 PM. |
PopupDateFormat::LongDateShortTime24 | 23 | Example: Tuesday, December 30, 1997, 17:32. |
PopupDateFormat::LongMonthDayYearLongTime | 24 | Example: December 30, 1997, 5:32:10 PM. |
PopupDateFormat::LongMonthDayYearLongTime24 | 25 | Example: December 30, 1997, 17:32:10. |
PopupDateFormat::LongMonthDayYearShortTime | 26 | Example: December 30, 1997, 6:00 PM. |
PopupDateFormat::LongMonthDayYearShortTime24 | 27 | Example: December 30, 1997, 18:00. |
PopupDateFormat::Unknown | -1 | Unknown date format |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.14] enum class PopupElementType
Enumerates types of PopupElement.
The PopupElementType can be one of:
| Constant | Value | Description |
|---|---|---|
PopupElementType::Unknown | -1 | an unknown value |
PopupElementType::TextPopupElement | 0 | Configures text in pop-up elements. |
PopupElementType::FieldsPopupElement | 1 | Configures field in pop-up elements. |
PopupElementType::MediaPopupElement | 2 | Configures media in pop-up elements. |
PopupElementType::AttachmentsPopupElement | 3 | Configures attachment in pop-up elements. |
PopupElementType::ExpressionPopupElement | 4 | Configures expression in pop-up elements. |
PopupElementType::RelationshipPopupElement | 5 | Configures relationship in pop-up elements. |
PopupElementType::UnsupportedPopupElement | 6 | An unsupported pop-up element. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.14.
[since Esri::ArcGISRuntime 100.0] enum class PopupErrorCode
Enumerates the error codes in a Popup.
PopupErrorCode can be one of:
| Constant | Value | Description |
|---|---|---|
PopupErrorCode::InvalidGeoElement | 11000 | Invalid attributes or geometry on the associated GeoElement. |
PopupErrorCode::NullNotAllowed | 11001 | Null value not allowed. |
PopupErrorCode::ValueOutOfRange | 11002 | Value is out of range. |
PopupErrorCode::ExceedsMaxLength | 11003 | Value exceeds the maximum length. |
PopupErrorCode::IllegalDomainCode | 11007 | Coded value domain code is not defined in the domain list. |
PopupErrorCode::ContingencyValidationFailure | 11008 | Field values do not satisfy the ContingentValuesDefinition. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.3] enum class PopupExpressionReturnType
Enumerates the type of the result returned by an Arcade expression.
PopupExpressionReturnType can be one of:
| Constant | Value | Description |
|---|---|---|
PopupExpressionReturnType::String | 0 | A string value is returned. |
PopupExpressionReturnType::Number | 1 | A numeric value is returned. |
PopupExpressionReturnType::Dictionary | 2 | The return type is expected to be a dictionary of key/value pairs that must follow the Web Map Specification for a popupElement. Refer to Popup Element for more details. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.3.
[since Esri::ArcGISRuntime 100.0] enum class PopupMediaType
Enumerates the type of media in a Popup.
PopupMediaType can be one of:
| Constant | Value | Description |
|---|---|---|
PopupMediaType::Image | 0 | An image. |
PopupMediaType::BarChart | 1 | A bar chart. |
PopupMediaType::ColumnChart | 2 | A column chart. |
PopupMediaType::LineChart | 3 | A line chart. |
PopupMediaType::PieChart | 4 | A pie chart. |
PopupMediaType::Unknown | -1 | An unknown media type. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0] enum class PopupStringFieldOption
Enumerates the string field options in a Popup.
PopupStringFieldOption can be one of:
| Constant | Value | Description |
|---|---|---|
PopupStringFieldOption::SingleLine | 0 | A single-line input box. |
PopupStringFieldOption::MultiLine | 1 | A multiline input box. |
PopupStringFieldOption::RichText | 2 | A rich text editor allowing for bold text, highlighting, and so forth. |
PopupStringFieldOption::Unknown | -1 | An unknown string field option. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.