LookmlModelExploreField.md

LookerApi31Reference.LookmlModelExploreField

Properties

Name	Type	Description	Notes
align	String	The appropriate horizontal text alignment the values of this field shoud be displayed in. Valid values are: "left", "right".	[optional]
canFilter	Boolean	Whether it's possible to filter on this field.	[optional]
category	String	Field category Valid values are: "parameter", "filter", "measure", "dimension".	[optional]
defaultFilterValue	String	The default value that this field uses when filtering. Null if there is no default value.	[optional]
description	String	Description	[optional]
enumerations	[LookmlModelExploreFieldEnumeration]	An array enumerating all the possible values that this field can contain. When null, there is no limit to the set of possible values this field can contain.	[optional]
error	String	An error message indicating a problem with the definition of this field. If there are no errors, this will be null.	[optional]
fieldGroupLabel	String	A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.	[optional]
fieldGroupVariant	String	When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.	[optional]
fillStyle	String	The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: "enumeration", "range".	[optional]
fiscalMonthOffset	Number	An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.	[optional]
hasAllowedValues	Boolean	Whether this field has a set of allowed_values specified in LookML.	[optional]
hidden	Boolean	Whether this field should be hidden from the user interface.	[optional]
isFilter	Boolean	Whether this field is a filter.	[optional]
isFiscal	Boolean	Whether this field represents a fiscal time value.	[optional]
isNumeric	Boolean	Whether this field is of a type that represents a numeric value.	[optional]
isTimeframe	Boolean	Whether this field is of a type that represents a time value.	[optional]
canTimeFilter	Boolean	Whether this field can be time filtered.	[optional]
timeInterval	LookmlModelExploreFieldTimeInterval	Details on the time interval this field represents, if it is_timeframe.	[optional]
label	String	Fully-qualified human-readable label of the field.	[optional]
labelFromParameter	String	The name of the parameter that will provide a parameterized label for this field, if available in the current context.	[optional]
labelShort	String	The human-readable label of the field, without the view label.	[optional]
lookmlLink	String	A URL linking to the definition of this field in the LookML IDE.	[optional]
mapLayer	LookmlModelExploreFieldMapLayer	If applicable, a map layer this field is associated with.	[optional]
measure	Boolean	Whether this field is a measure.	[optional]
name	String	Fully-qualified name of the field.	[optional]
strictValueFormat	Boolean	If yes, the field will not be localized with the user attribute number_format. Defaults to no	[optional]
parameter	Boolean	Whether this field is a parameter.	[optional]
permanent	Boolean	Whether this field can be removed from a query.	[optional]
primaryKey	Boolean	Whether or not the field represents a primary key.	[optional]
projectName	String	The name of the project this field is defined in.	[optional]
requiresRefreshOnSort	Boolean	When true, it's not possible to re-sort this field's values without re-running the SQL query, due to database logic that affects the sort.	[optional]
scope	String	The LookML scope this field belongs to. The scope is typically the field's view.	[optional]
sortable	Boolean	Whether this field can be sorted.	[optional]
sourceFile	String	The path portion of source_file_path.	[optional]
sourceFilePath	String	The fully-qualified path of the project file this field is defined in.	[optional]
sql	String	SQL expression as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.	[optional]
sqlCase	[LookmlModelExploreFieldSqlCase]	An array of conditions and values that make up a SQL Case expression, as defined in the LookML model. The SQL syntax shown here is a representation intended for auditability, and is not neccessarily an exact match for what will ultimately be run in the database. It may contain special LookML syntax or annotations that are not valid SQL. This will be null if the current user does not have the see_lookml permission for the field's model.	[optional]
suggestDimension	String	The name of the dimension to base suggest queries from.	[optional]
suggestExplore	String	The name of the explore to base suggest queries from.	[optional]
suggestable	Boolean	Whether or not suggestions are possible for this field.	[optional]
suggestions	[String]	If available, a list of suggestions for this field. For most fields, a suggest query is a more appropriate way to get an up-to-date list of suggestions. Or use enumerations to list all the possible values.	[optional]
tags	[String]	An array of arbitrary string tags provided in the model for this field.	[optional]
type	String	The LookML type of the field.	[optional]
userAttributeFilterTypes	[String]	An array of user attribute types that are allowed to be used in filters on this field. Valid values are: "advanced_filter_string", "advanced_filter_number", "advanced_filter_datetime", "string", "number", "datetime", "yesno", "zipcode".	[optional]
valueFormat	String	If specified, the LookML value format string for formatting values of this field.	[optional]
view	String	The name of the view this field belongs to.	[optional]
viewLabel	String	The human-readable label of the view the field belongs to.	[optional]
dynamic	Boolean	Whether this field was specified in "dynamic_fields" and is not part of the model.	[optional]
weekStartDay	String	The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".	[optional]