LookmlModelExploreField.md

LookmlModelExploreField

Properties

Name	Type	Description	Notes
align	str	The appropriate horizontal text alignment the values of this field shoud be displayed in. Valid values are: "left", "right".	[optional]
can_filter	bool	Whether it's possible to filter on this field.	[optional]
category	str	Field category Valid values are: "parameter", "filter", "measure", "dimension".	[optional]
default_filter_value	str	The default value that this field uses when filtering. Null if there is no default value.	[optional]
description	str	Description	[optional]
enumerations	list[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	str	An error message indicating a problem with the definition of this field. If there are no errors, this will be null.	[optional]
field_group_label	str	A label creating a grouping of fields. All fields with this label should be presented together when displayed in a UI.	[optional]
field_group_variant	str	When presented in a field group via field_group_label, a shorter name of the field to be displayed in that context.	[optional]
fill_style	str	The style of dimension fill that is possible for this field. Null if no dimension fill is possible. Valid values are: "enumeration", "range".	[optional]
fiscal_month_offset	int	An offset (in months) from the calendar start month to the fiscal start month defined in the LookML model this field belongs to.	[optional]
has_allowed_values	bool	Whether this field has a set of allowed_values specified in LookML.	[optional]
hidden	bool	Whether this field should be hidden from the user interface.	[optional]
is_filter	bool	Whether this field is a filter.	[optional]
is_fiscal	bool	Whether this field represents a fiscal time value.	[optional]
is_numeric	bool	Whether this field is of a type that represents a numeric value.	[optional]
is_timeframe	bool	Whether this field is of a type that represents a time value.	[optional]
can_time_filter	bool	Whether this field can be time filtered.	[optional]
time_interval	LookmlModelExploreFieldTimeInterval	Details on the time interval this field represents, if it is_timeframe.	[optional]
label	str	Fully-qualified human-readable label of the field.	[optional]
label_from_parameter	str	The name of the parameter that will provide a parameterized label for this field, if available in the current context.	[optional]
label_short	str	The human-readable label of the field, without the view label.	[optional]
lookml_link	str	A URL linking to the definition of this field in the LookML IDE.	[optional]
map_layer	LookmlModelExploreFieldMapLayer	If applicable, a map layer this field is associated with.	[optional]
measure	bool	Whether this field is a measure.	[optional]
name	str	Fully-qualified name of the field.	[optional]
parameter	bool	Whether this field is a parameter.	[optional]
permanent	bool	Whether this field can be removed from a query.	[optional]
primary_key	bool	Whether or not the field represents a primary key.	[optional]
project_name	str	The name of the project this field is defined in.	[optional]
requires_refresh_on_sort	bool	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	str	The LookML scope this field belongs to. The scope is typically the field's view.	[optional]
sortable	bool	Whether this field can be sorted.	[optional]
source_file	str	The path portion of source_file_path.	[optional]
source_file_path	str	The fully-qualified path of the project file this field is defined in.	[optional]
sql	str	SQL expression as defined in the LookML model. This will be null if the current user does not have the see_lookml permission for the field's model.	[optional]
sql_case	list[LookmlModelExploreFieldSqlCase]	An array of conditions and values that make up a SQL Case expression, as defined in the LookML model. This will be null if the current user does not have the see_lookml permission for the field's model.	[optional]
suggest_dimension	str	The name of the dimension to base suggest queries from.	[optional]
suggest_explore	str	The name of the explore to base suggest queries from.	[optional]
suggestable	bool	Whether or not suggestions are possible for this field.	[optional]
suggestions	list[str]	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	list[str]	An array of arbitrary string tags provided in the model for this field.	[optional]
type	str	The LookML type of the field.	[optional]
user_attribute_filter_types	list[str]	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]
value_format	str	If specified, the LookML value format string for formatting values of this field.	[optional]
view	str	The name of the view this field belongs to.	[optional]
view_label	str	The human-readable label of the view the field belongs to.	[optional]
dynamic	bool	Whether this field was specified in "dynamic_fields" and is not part of the model.	[optional]
week_start_day	str	The name of the starting day of the week. Valid values are: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".	[optional]

[Back to Model list] [Back to API list] [Back to README]