date-picker operations
Reference for @astrato-io/visualizations@0.6.5.
Use each schema below for the request’s payload, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
Available operations
Section titled “Available operations”addDatePickerDimensionremoveDatePickerDimensionsetDatePickerBackgroundColorsetDatePickerCustomDatePresetssetDatePickerEndDateLabelsetDatePickerHoverColorsetDatePickerQuickSelectsetDatePickerResponsivesetDatePickerSelectedColorsetDatePickerStartDateLabelsetDatePickerStatesetDatePickerTimePickerVisibilitysetDatePickerTypesetDatePickerVisibleDatePresetssetDatePickerWeekStartsetStaticFilterGroup
addDatePickerDimension
Section titled “addDatePickerDimension”Add date picker dimension
Add one date dimension to the date picker
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"" } }, "required": ["key"], "additionalProperties": false, "title": "Add date picker dimension schema"}removeDatePickerDimension
Section titled “removeDatePickerDimension”Remove date picker dimension
Remove the date dimension from the date picker
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "dataItemInternalKey": { "type": "string", "description": "Internal key of the data item of the dimension to be removed" }, "dataItemUniqueSignature": { "type": "string", "description": "Unique signature of the data item of the dimension to be removed" } }, "required": ["dataItemInternalKey", "dataItemUniqueSignature"], "additionalProperties": false, "title": "Remove date picker dimension schema"}setDatePickerBackgroundColor
Section titled “setDatePickerBackgroundColor”Date picker background color
Set the date picker background color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Date picker background color schema"}setDatePickerCustomDatePresets
Section titled “setDatePickerCustomDatePresets”Date picker custom date presets
Set custom rolling date range presets
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker custom date presets schema", "type": "array", "items": { "type": "object", "properties": { "rangeType": { "type": "string", "enum": ["day", "month", "year"] }, "rangeValue": { "type": "number", "minimum": 0 } }, "required": ["rangeType", "rangeValue"], "additionalProperties": false }}setDatePickerEndDateLabel
Section titled “setDatePickerEndDateLabel”Date picker end date label
Set the end-date input label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker end date label schema", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ]}setDatePickerHoverColor
Section titled “setDatePickerHoverColor”Date picker hover color
Set the date picker hover color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Date picker hover color schema"}setDatePickerQuickSelect
Section titled “setDatePickerQuickSelect”Date picker quick select
Enable or disable immediate filtering when a date is selected
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker quick select schema", "type": "boolean"}setDatePickerResponsive
Section titled “setDatePickerResponsive”Date picker responsive sizing
Enable or disable responsive sizing for the date picker
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker responsive schema", "type": "boolean"}setDatePickerSelectedColor
Section titled “setDatePickerSelectedColor”Date picker selected color
Set the date picker selected date color
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$" }, { "type": "null" } ], "title": "Date picker selected color schema"}setDatePickerStartDateLabel
Section titled “setDatePickerStartDateLabel”Date picker start date label
Set the single-date or start-date input label
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker start date label schema", "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, { "type": "null" } ]}setDatePickerState
Section titled “setDatePickerState”Date picker state
Set whether the calendar is collapsed or expanded
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["expanded", "collapsed"], "title": "Date picker state schema"}setDatePickerTimePickerVisibility
Section titled “setDatePickerTimePickerVisibility”Date picker time picker visibility
Set when the time picker is visible
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker time picker visibility schema", "type": "string", "enum": ["always", "whenTimestampSelected", "never"]}setDatePickerType
Section titled “setDatePickerType”Date picker type
Set whether the date picker selects a single date or a date range
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["range", "inputRange", "inputSingle"], "title": "Date picker type schema"}setDatePickerVisibleDatePresets
Section titled “setDatePickerVisibleDatePresets”Date picker visible date presets
Set which predefined date range presets are visible
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Date picker visible date presets schema", "type": "array", "items": { "type": "string", "enum": [ "Last 12 Months", "Last 90 days", "Last 30 days", "Last 7 days", "Current year", "Current quarter", "Current month", "Current MTD", "Previous month", "Previous MTD", "Previous quarter", "Previous QTD", "Previous week", "Previous week to date", "Previous year", "Previous YTD", "Current QTD", "Today", "Current week to date", "Current YTD", "Yesterday" ] }}setDatePickerWeekStart
Section titled “setDatePickerWeekStart”Date picker week start
Set whether the calendar week starts on Sunday or Monday
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": ["1", "0"], "title": "Date picker week start schema"}setStaticFilterGroup
Section titled “setStaticFilterGroup”Set static filter group
Replace all static filters with a nested AND/OR filter group.
Payload schema
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Replace all static filters with this nested AND/OR filter group.", "title": "Set static filter group schema", "$ref": "#/$defs/__schema0", "$defs": { "__schema0": { "type": "object", "properties": { "operator": { "type": "string", "enum": ["and", "or"] }, "filters": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "fieldKey": { "type": "string", "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label." }, "operator": { "anyOf": [ { "type": "string", "enum": [ "equals", "doesNotEqual", "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "isBetween", "isNotBetween", "isNull", "notNull", "contains", "excludes", "like", "notLike", "startsWith", "endsWith", "predefined_date_range", "previous", "current", "before", "after", "inList", "excludedFromList", "divider" ] }, { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] } ] }, "values": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueFrom": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "valueTo": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] }, "secondValue": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "const": "variable" }, "variableName": { "type": "string" } }, "required": ["type", "variableName"], "additionalProperties": false } ] } }, "additionalProperties": false }, "dateFilter": { "anyOf": [ { "type": "string", "enum": [ "ytd", "mtd", "qtd", "wtd", "pytd", "pmtd", "pqtd", "pwtd", "l12m", "l90d", "l30d", "l7d", "cy", "cq", "cm", "py", "pm", "pq", "pw", "today", "yesterday", "mindate", "maxdate" ] }, { "type": "null" } ] } }, "required": ["fieldKey", "operator", "values"], "additionalProperties": false }, { "$ref": "#/$defs/__schema0" } ] } } }, "required": ["operator", "filters"], "additionalProperties": false } }}