census

Documentation

Index

• type DatasetLandingPage
• type Page
• type Panel
  • func (p Panel) FuncGetPanelType() (panelType string)
• type PanelType
• type RelatedContentItem
• type Share
• type ShareDetails

Types

type DatasetLandingPage

type DatasetLandingPage struct {
	HasOtherVersions    bool                    `json:"has_other_versions"`
	HasDownloads        bool                    `json:"has_downloads"`
	LatestVersionURL    string                  `json:"latest_version_url"`
	Dimensions          []sharedModel.Dimension `json:"dimensions"`
	ShareDetails        ShareDetails
	Description         []string             `json:"description"`
	IsCustom            bool                 `json:"is_custom"`
	IsFlexibleForm      bool                 `json:"is_flexible_form"`
	DatasetURL          string               `json:"dataset_url"`
	Panels              []Panel              `json:"panels"`
	QualityStatements   []Panel              `json:"quality_statements"`
	SDC                 []Panel              `json:"sdc"`
	HasSDC              bool                 `json:"has_sdc"`
	RelatedContentItems []RelatedContentItem `json:"related_content_items"`
	IsMultivariate      bool                 `json:"is_multivariate"`
	ShowXLSXInfo        bool                 `json:"show_xlsx_info"`
	ImproveResults      model.Collapsible
}

DatasetLandingPage contains properties related to the census dataset landing page

type Page

type Page struct {
	model.Page
	DatasetLandingPage  DatasetLandingPage    `json:"data"`
	Version             sharedModel.Version   `json:"version"`
	Versions            []sharedModel.Version `json:"versions"`
	ID                  string                `json:"id"`
	ContactDetails      contact.Details       `json:"contact_details"`
	HasContactDetails   bool                  `json:"has_contact_details"`
	IsNationalStatistic bool                  `json:"is_national_statistic"`
	ShowCensusBranding  bool                  `json:"show_census_branding"`
}

Page contains data for the census landing page

type Panel

type Panel struct {
	Type        PanelType `json:"type"`
	DisplayIcon bool      `json:"display_icon"`
	CSSClasses  []string  `json:"css_classes"`
	Body        []string  `json:"body"`
	Language    string    `json:"language"`
}

Panel contains the data required to populate a panel UI component

func (Panel) FuncGetPanelType

func (p Panel) FuncGetPanelType() (panelType string)

FuncGetPanelType returns the panel type as a string

type PanelType

type PanelType int

const (
	Info PanelType = iota
	Pending
	Success
	Error
)

type RelatedContentItem

type RelatedContentItem struct {
	Title string `json:"title"`
	Link  string `json:"link"`
	Text  string `json:"text"`
}

RelatedContentItem contains details for a section of related content

type Share

type Share struct {
	Title string `json:"title"`
	Link  string `json:"link"`
	Icon  string `json:"icon"`
}

Share includes details for a specific place the dataset can be shared Included icons: 'facebook', 'twitter', 'email', 'linkedin'

type ShareDetails

type ShareDetails struct {
	ShareLocations []Share `json:"share_locations"`
	Language       string  `json:"language"`
}

ShareDetails contains the locations the page can be shared to, as well as the language attribute for localisation