Versions Compared

Key

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

...

KeyTypeOptionalityDescriptionConstraints
breaksarray

Status
colourGreen
titleoptional

array of distribution break values (integer or decimal)

size = 6 (standard, positive, negative, inverse, heat, heatmap, traffic, trafficInverse, magma and viridis scale)

size = 3 (binaryStandard and binaryNegative scale)

size = 7 (divergingStandard and divergingNegative scale)

displayIntervalsarray
Status
colourGreen
titleoptional
specifies which scale intervals should be displayed


content.**.itemId

Generated ID for this item to be used for matching it within a parent array while rebasing share objects. itemId is genrated as hash from random UUID when given item is being created - either an entire dashboard is being created or an item is being added to MD object content via update. Once itemId is generated it is not supposed to be modified.

IMPORTANT: When interacting with REST API do not provide own generated values as itemId;

  • if an item is being created do not provide itemId attribute at all - it will be generated at backend and returend within a response payload
  • if an item is being updated provide the value of itemId which was previously retrieved from backend via REST API - this value will be used for matching the item with share object diffs while rebasing a share object

...