Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

View is a visualization of certain theme using a set of related indicators and groups of objects (markers or areas) displayed on a map. View also contains the definition of filters.

...

KeyTypeOptionalityDescriptionConstraints
iconstring

Status
colourGreen
titleoptional

identifier of the view icon as shown on the project page

see the available icons below

["catchment_area", "atm_cash_machine", "city_buildings", "credit_cards", "customer_intelligence", "diagram_chart", "fast_delivery", "first_place_pedestal", "hourglass_sandclock", "location_mark", "market_potential", "market_trends", "market_vision", "optimism_and_happiness", "packaging_box", "performance_method", "rent_a_house", "road_route", "shopping_cart", "tactical_advantage", "venture_capital", "wealth_accumulation", "workgroup_people"]
orderinteger
Status
colourGreen
titleoptional

specifies the order of the view on the Project page

secondary ordering is by title, alphabetically 

x => 1
dashboardstring

Status
colourRed
titlerequired

URL link to the dashboard, which the view contains

/rest/projects/$projectId/md/dashboards?name={dashboardName}
markerSelectorstring

Status
colourGreen
titleoptional

URL link to the marker selector, which the view contains

/rest/projects/$projectId/md/markerSelectors?name={markerSelectorName}
markersOnlyboolean
Status
colourGreen
titleoptional

enables the marker only view (see the tutorial)

default = false

[true, false]
showAttributesOnDrillboolean
Status
colourGreen
titleoptional
enables feature attributes visibility after clicking on a indicator drill[true, false]
defaultGranularitystring
Status
colourGreen
titleoptional
URL link to the dataset, which will be the selected as the default granularity level when entering the view/rest/projects/$projectId/md/datasets?name={datasetName}
defaultVisualizedstring
Status
colourGreen
titleoptional
URL link to the indicator, which will be the visualised by default when entering the view/rest/projects/$projectId/md/indicators?name={indicatorName}
defaultVisualizationstring
Status
colourGreen
titleoptional
specifies default visualization selected when entering the view[areas, grid, zones, heatmap, dotmap, line]
defaultDrilledstring
Status
colourGreen
titleoptional
URL link to the indicator, which will be the drilled down to by default when entering the view/rest/projects/$projectId/md/indicators?name={indicatorName}
defaultToolstring
Status
colourGreen
titleoptional

specify a tool which will be active by default when entering the view

search = , filter = , visibility =, measure =

[search, filter, visibility, measure]
defaultCompareTypestring
Status
colourGreen
titleoptional
specifies default compare type selected when using compare[dominance, overlap]
filterGrouparray

Status
colourGreen
titleoptional

array of filters applicable to the indicators presented in this view

[indicatorglobalDate, datehistogram, multiSelect, variables]
spatialQueryobject
Status
colourGreen
titleoptional
default spatial query settings (used in heatmap visualization)x => 1
fitnessGroupsinteger
Status
colourGreen
titleoptional

specifies the number of indicator fitness segments

this setting's scope is view, so it will affect all indicators in the view

[3, 5]
mapOptionsobject
Status
colourGreen
titleoptional
map window settings on the project page
mapContextMenuobject
Status
colourGreen
titleoptional
array of objects with definition of 3rd party services available on mouse context click
exportsobject
Status
colourGreen
titleoptional
array of export references which allows you to define exports per view
measureobject
Status
colourGreen
titleoptional
measure tool settings
defaultSelectedobject
Status
colourGreen
titleoptional
specify objects selected by default when entering the view
excludeDatasetsarray
Status
colourGreen
titleoptional
array of dataset names (not links) to be excluded from the granularity dropdown menu

...

KeyTypeOptionalityDescriptionConstraints
valuestring
Status
colourGreen
titleoptional

given value in the ISO 8601 format

format = YYYY-MM-DD

functionobject
Status
colourGreen
titleoptional

a function object defining an interval of a relative date filter


...

Date rangeDefinition syntax
the day before 30 daysfunction_today  function_interval(30, day)
the beginning of the current weekfunction_date_trunc(today, week)​

​the beginning of last week

function_date_trunc(today, week)​  function_interval(1, week)
the day before two monthsfunction_today  function_interval(2, month)
the ending of the last monthfunction_date_trunc(today, month)​  function_interval(1, day)

...

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always multiSelect

[multiSelect]
propertyobject

Status
colourRed
titlerequired

identifier of a dataset property, which the filter will be applied to

{datasetName}.{datasetProperty}
orderByobject

Status
colourGreen
titleoptional

specifies how to order the multiselect list


defaultValuesobject
Status
colourGreen
titleoptional

object containing default values for the multiselect filter

(warning) if present, please note that this will make this filter active all the time


...

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always variables

[variables]

title

string

Status
colourRed
titlerequired

title of the variables filter

(*)
variablesarray
Status
colourRed
titlerequired
array of the content.filterGroup.variables.variable objectssize => 1

...

KeyTypeOptionalityDescriptionConstraints
typestring

Status
colourRed
titlerequired

type identifier, always feature

[feature]

dataset

string

Status
colourRed
titlerequired

link to a dataset whose features will be filtered/rest/projects/$projectId/md/datasets?name={datasetName}
defaultValuesobject
Status
colourRed
titlerequired

object containing default string values for the feature filter

see example above

size => 1

...

This is the available view icon palette.

atm_cash_machinecatchment_areacity_buildingscredit_cardscustomer_intelligencediagram_chartfast_deliveryfirst_place_pedestalhourglass_sandclocklocation_mark


market_potentialmarket_trendsmarket_visionoptimism_and_happinesspackaging_boxperformance_methodrent_a_houseroad_routeshopping_carttactical_advantage

Image Modified

Image Modified

Image Modified

Image Modified

Image ModifiedImage ModifiedImage ModifiedImage ModifiedImage ModifiedImage Modified


venture_capitalwealth_accumulationworkgroup_people

Views displayed on the project page

Image RemovedImage Added

Map base layers

mapboxmapboxStreetsmapboxOutdoors

Image Modified

Image Modified
Image Modified
mapboxSatelliteStreetsmapboxLightmapboxDark
Image Modified
Image Modified
Image Modified

globalDate filter type

in default statewith set values

...