TemplateSelectPropertyBuilder
Defined in: builder/template.ts:34
Extends
Section titled “Extends”BaseBuilder.SelectPropertyBuilder.TemplatePropertyBase
Properties
Section titled “Properties”isArchived
Section titled “isArchived”
readonlyisArchived:boolean
Defined in: builder/property.ts:4
Inherited from
Section titled “Inherited from”SelectPropertyBuilder.isArchived
readonlykey:string
Defined in: builder/property.ts:5
Inherited from
Section titled “Inherited from”
readonlylabel:string
Defined in: builder/property.ts:6
Inherited from
Section titled “Inherited from”options
Section titled “options”
readonlyoptions:SelectOptionDefinition[]
Defined in: builder/property.ts:27
Inherited from
Section titled “Inherited from”
readonlyprn:string
Defined in: builder/index.ts:32
Inherited from
Section titled “Inherited from”
readonlytype:PropertyDefinitionType
Defined in: builder/property.ts:7
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addOption()
Section titled “addOption()”addOption(
key,input):this
Defined in: builder/property.ts:28
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”SelectPropertyBuilder.addOption
archive()
Section titled “archive()”archive():
this
Defined in: builder/property.ts:9
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”index()
Section titled “index()”index():
this
Defined in: builder/template.ts:21
Flags that this property should be indexed. Indexed properties can
be used as where filters in selectors. They can also be used for sorting.
Not all property types can be indexed; and there are a limits on the number
of indexes available:
Returns
Section titled “Returns”this
https://www.notion.so/pynhq/Index-Limits-490d3de6d0aa4a92beb44db7df84f121?pvs=4
Inherited from
Section titled “Inherited from”TemplatePropertyBase.index
setDescription()
Section titled “setDescription()”setDescription(
description):this
Defined in: builder/index.ts:33
Parameters
Section titled “Parameters”description
Section titled “description”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”setLabel()
Section titled “setLabel()”setLabel(
label):this
Defined in: builder/property.ts:10
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”SelectPropertyBuilder.setLabel
toDefinition()
Section titled “toDefinition()”toDefinition():
PropertyDefinition
Defined in: builder/property.ts:16
Returns the definition object for this transition.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”SelectPropertyBuilder.toDefinition
unarchive()
Section titled “unarchive()”unarchive():
this
Defined in: builder/property.ts:11
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”SelectPropertyBuilder.unarchive
unique()
Section titled “unique()”unique():
this
Defined in: builder/template.ts:29
Unique functions as both an index, but also enforces the contraint that this property must have unique values for the template specified (within the same workspace, naturally).
Returns
Section titled “Returns”this
https://www.notion.so/pynhq/Unique-Index-Limits-e763fdea7d5a4c25b824967b3c6bb390?pvs=4
Inherited from
Section titled “Inherited from”TemplatePropertyBase.unique