<PopupTypes.h> - Popup Enums

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:

ConstantValueDescription
ChartImageStyle::Neutral0The 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::Light1The light style.
ChartImageStyle::Dark2The 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:

ConstantValueDescription
FeatureTypeChangeMode::ResetToDefaults0Resets all fields to the default values defined in the feature template prototype.
FeatureTypeChangeMode::KeepValues1Keeps 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:

ConstantValueDescription
PopupAttachmentEditState::Original0Attachments that already existed on the GeoElement and have not been deleted are considered original.
PopupAttachmentEditState::Added1Attachments that have been provided via a URL or directly via data and then added to a GeoElement are considered added.
PopupAttachmentEditState::Deleted2Attachments that existed on the GeoElement but have been removed are considered deleted.
PopupAttachmentEditState::Unknown-1An 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:

ConstantValueDescription
PopupAttachmentType::Image0An image.
PopupAttachmentType::Video1A video.
PopupAttachmentType::Document2A document.
PopupAttachmentType::Other3Other.

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:

ConstantValueDescription
PopupAttachmentsDisplayType::List0Show attachments as links.
PopupAttachmentsDisplayType::Preview1Attachments expand to the width of the pop-up.
PopupAttachmentsDisplayType::Auto2Allows 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

Enumerates the date format for a Popup.

PopupDateFormat can be one of:

ConstantValueDescription
PopupDateFormat::DayShortMonthYear0Example: 30 Dec 1997
PopupDateFormat::LongDate1Example: Tuesday, December 30, 1997
PopupDateFormat::LongMonthDayYear2Example: December 30, 1997
PopupDateFormat::LongMonthYear3Example: December 1997
PopupDateFormat::ShortDate4Example: 12/30/1997
PopupDateFormat::ShortDateLE5Example: 30/12/1997
PopupDateFormat::ShortDateLELongTime6Example: 30/12/1997 5:59:59 PM
PopupDateFormat::ShortDateLELongTime247Example: 30/12/1997 17:59:59
PopupDateFormat::ShortDateLEShortTime8Example: 30/12/1997 6:00 PM
PopupDateFormat::ShortDateLEShortTime249Example: 30/12/1997 18:00
PopupDateFormat::ShortDateLongTime10Example: 12/30/1997 5:59:59 PM
PopupDateFormat::ShortDateLongTime2411Example: 12/30/1997 17:59:59
PopupDateFormat::ShortDateShortTime12Example: 12/30/1997 6:00 PM
PopupDateFormat::ShortDateShortTime2413Example: 12/30/1997 18:00
PopupDateFormat::ShortMonthYear14Example: Dec 1997
PopupDateFormat::Year15Example: 1997
PopupDateFormat::Unknown-1Unknown 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:

ConstantValueDescription
PopupElementType::Unknown-1an unknown value
PopupElementType::TextPopupElement0Configures text in pop-up elements.
PopupElementType::FieldsPopupElement1Configures field in pop-up elements.
PopupElementType::MediaPopupElement2Configures media in pop-up elements.
PopupElementType::AttachmentsPopupElement3Configures attachment in pop-up elements.
PopupElementType::ExpressionPopupElement4Configures expression in pop-up elements.
PopupElementType::RelationshipPopupElement5Configures relationship in pop-up elements.
PopupElementType::UnsupportedPopupElement6An 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:

ConstantValueDescription
PopupErrorCode::InvalidGeoElement11000Invalid attributes or geometry on the associated GeoElement.
PopupErrorCode::NullNotAllowed11001Null value not allowed.
PopupErrorCode::ValueOutOfRange11002Value is out of range.
PopupErrorCode::ExceedsMaxLength11003Value exceeds the maximum length.
PopupErrorCode::IllegalDomainCode11007Coded value domain code is not defined in the domain list.
PopupErrorCode::ContingencyValidationFailure11008Field 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:

ConstantValueDescription
PopupExpressionReturnType::String0A string value is returned.
PopupExpressionReturnType::Number1A numeric value is returned.
PopupExpressionReturnType::Dictionary2The 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:

ConstantValueDescription
PopupMediaType::Image0An image.
PopupMediaType::BarChart1A bar chart.
PopupMediaType::ColumnChart2A column chart.
PopupMediaType::LineChart3A line chart.
PopupMediaType::PieChart4A pie chart.
PopupMediaType::Unknown-1An 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:

ConstantValueDescription
PopupStringFieldOption::SingleLine0A single-line input box.
PopupStringFieldOption::MultiLine1A multiline input box.
PopupStringFieldOption::RichText2A rich text editor allowing for bold text, highlighting, and so forth.
PopupStringFieldOption::Unknown-1An unknown string field option.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.