-
Notifications
You must be signed in to change notification settings - Fork 16
/
icolumn.yml
109 lines (109 loc) · 3.93 KB
/
icolumn.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
### YamlMime:TSType
name: IColumn
uid: '@microsoft/sp-listview-extensibility!IColumn:interface'
package: '@microsoft/sp-listview-extensibility!'
fullName: IColumn
summary: Provides information about the state of a column in the list view
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: clientSideComponentId
uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentId:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: clientSideComponentId
summary: The unique identifier of the client-side component associated with the field.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly clientSideComponentId: Guid | undefined;'
return:
type: '<xref uid="@microsoft/sp-core-library!Guid:class" /> | undefined'
- name: clientSideComponentProperties
uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentProperties:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: clientSideComponentProperties
summary: This property is only used when a `ClientSideComponentId` is specified. It is optional.
remarks: >-
If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning
are defined by the client-side component.
isPreview: false
isDeprecated: false
syntax:
content: 'readonly clientSideComponentProperties: string;'
return:
type: string
- name: displayName
uid: '@microsoft/sp-listview-extensibility!IColumn#displayName:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: displayName
summary: The display name of the field. This name is shown as column name in UI.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly displayName: string;'
return:
type: string
- name: fieldType
uid: '@microsoft/sp-listview-extensibility!IColumn#fieldType:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: fieldType
summary: The type of the field represented as a string
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly fieldType: string;'
return:
type: string
- name: id
uid: '@microsoft/sp-listview-extensibility!IColumn#id:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: id
summary: The GUID identifier for this field.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: Guid;'
return:
type: '<xref uid="@microsoft/sp-core-library!Guid:class" />'
- name: internalName
uid: '@microsoft/sp-listview-extensibility!IColumn#internalName:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: internalName
summary: The internal name of the field. This name is usually used to find the field.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly internalName: string;'
return:
type: string
- name: isRequired
uid: '@microsoft/sp-listview-extensibility!IColumn#isRequired:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: isRequired
summary: Whether the field is required for each list item in the list
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly isRequired: boolean;'
return:
type: boolean
- name: isVisible
uid: '@microsoft/sp-listview-extensibility!IColumn#isVisible:member'
package: '@microsoft/sp-listview-extensibility!'
fullName: isVisible
summary: Whether the column is visible in the view
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly isVisible: boolean;'
return:
type: boolean