Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChangeDimensions ¶ added in v1.17.0
type ChangeDimensions struct {
coreModel.Page
Output SearchOutput `json:"output"`
SearchOutput SearchOutput `json:"search_output"`
Search SearchField `json:"search"`
FormAction string `json:"form_action"`
Panel Panel `json:"panel"`
HasSDC bool `json:"has_sdc"`
MaxVariableError bool `json:"max_variable_error"`
ImproveResults coreModel.Collapsible
}
ChangeDimensions represents the data to display a ChangeDimensions page
type Coverage ¶ added in v1.6.0
type Coverage struct {
coreModel.Page
Geography string `json:"geography"`
Dimension string `json:"dimension"`
GeographyID string `json:"geography_id"`
ParentSelect []SelectableElement `json:"parent_select"`
NameSearch SearchField `json:"name_search"`
ParentSearch SearchField `json:"parent_search"`
CoverageType string `json:"coverage_type"`
NameSearchOutput SearchOutput `json:"name_search_output"`
ParentSearchOutput SearchOutput `json:"parent_search_output"`
IsSelectParents bool `json:"is_select_parents"`
OptionType string `json:"option_type"`
SetParent string `json:"set_parent"`
}
Coverage represents the data to display the coverage page
type Dimension ¶ added in v1.2.0
type Dimension struct {
Options []string `json:"options"`
IsTruncated bool `json:"is_truncated"`
TruncateLink string `json:"truncate_link"`
OptionsCount int `json:"options_count"`
Name string `json:"name"`
ID string `json:"id"`
URI string `json:"uri"`
IsGeography bool `json:"is_geography"`
HasCategories bool `json:"has_categories"`
HasChange bool `json:"has_change"`
}
Dimension represents the data for a single dimension
type FilterDimension ¶ added in v1.13.0
FilterDimension represents a DTO for filter.Dimension with the additional OptionsCount field
type Overview ¶
type Overview struct {
coreModel.Page
FilterID string `json:"filter_id"`
Panel Panel `json:"panel"`
Dimensions []Dimension `json:"dimensions"`
IsMultivariate bool `json:"is_multivariate"`
ShowGetDataButton bool `json:"show_get_data_button"`
DisableGetDataButton bool `json:"disable_get_data_button"`
HasSDC bool `json:"has_sdc"`
MaxVariableError bool `json:"max_variable_error"`
ImproveResults coreModel.Collapsible
DimensionDescriptions coreModel.Collapsible
}
Overview represents the data to display the overview page
type Panel ¶ added in v1.23.0
type Panel struct {
Type PanelType `json:"type"`
CssClasses []string `json:"css_classes"`
Body string `json:"body"`
SafeHTML []string `json:"safe_html"`
Language string `json:"language"`
}
Panel contains the data required to populate a panel UI component
func (Panel) FuncGetPanelType ¶ added in v1.25.0
FuncGetPanelType returns the panel type as a string
type SearchField ¶ added in v1.11.0
type SearchField struct {
Value string `json:"value"`
Name string `json:"name"`
ID string `json:"id"`
Language string `json:"language"`
Label string `json:"label"`
}
SearchField represents the data required to populate the search input partial
type SearchOutput ¶ added in v1.11.0
type SearchOutput struct {
HasNoResults bool `json:"has_no_results"`
HasValidationError bool `json:"has_validation_error"`
Results []SelectableElement `json:"search_results"`
Selections []SelectableElement `json:"selections"`
SelectionsTitle string `json:"selections_title"`
Language string `json:"language"`
coreModel.Pagination
}
SearchOutput represents the presentable data required to display search output section
HasNoResults is a bool which displays messaging if there are no search results Results is an array of results Selections is an array of previously added selections Language is the user set language
type SelectableElement ¶ added in v1.11.0
type SelectableElement struct {
Text string `json:"text"`
InnerText string `json:"inner_text"`
Value string `json:"value"`
Name string `json:"name"`
QualityStatement Panel `json:"quality_statement"`
IsSelected bool `json:"is_selected"`
IsDisabled bool `json:"is_disabled"`
}
SelectableElement represents the data required for a selectable element.
Text is the human readable label. InnerText is human readable inner text within the element. Value is the value sent to the server. Name is the name attribute. IsSelected is a boolean representing whether the element is selected. IsDisabled is a boolean representing whether the element is disabled
type Selection ¶ added in v1.2.0
type Selection struct {
Value string
Label string
Description string
Categories []string
CategoriesCount int
TotalCount int
IsTruncated bool
TruncateLink string
IsSuggested bool
}
Selection represents a dimension selection (e.g. an Area-type of City)
type Selector ¶ added in v1.2.0
type Selector struct {
coreModel.Page
Dimensions Dimension `json:"dimensions"`
Selections []Selection
InitialSelection string
IsAreaType bool
LeadText string `json:"lead_text"`
ErrorId string `json:"error_id"`
Panel Panel `json:"panel"`
}
Selector represents page data for the Dimension selection screen
Source Files