-
Notifications
You must be signed in to change notification settings - Fork 16
/
webpartcontext.yml
83 lines (83 loc) · 3.41 KB
/
webpartcontext.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
### YamlMime:TSType
name: WebPartContext
uid: '@microsoft/sp-webpart-base!WebPartContext:class'
package: '@microsoft/sp-webpart-base!'
fullName: WebPartContext
summary: >-
Web part context object. This object contains the contextual services available to a web part. e.g. a contextual
instance to the http client.
remarks: >-
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or
create subclasses that extend the `WebPartContext` class.
isPreview: false
isDeprecated: false
type: class
properties:
- name: domElement
uid: '@microsoft/sp-webpart-base!WebPartContext#domElement:member'
package: '@microsoft/sp-webpart-base!'
fullName: domElement
summary: Reference to the DOM element that hosts this client-side component.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get domElement(): HTMLElement;'
return:
type: HTMLElement
- name: microsoftTeams
uid: '@microsoft/sp-webpart-base!WebPartContext#microsoftTeams:member'
package: '@microsoft/sp-webpart-base!'
fullName: microsoftTeams
summary: >-
Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is
being hosted in Microsoft Teams.
remarks: >-
For more information, please see:
[https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest](https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest)
isPreview: false
isDeprecated: true
customDeprecatedMessage: '- This function has been deprecated'
syntax:
content: 'get microsoftTeams(): typeof microsoftTeams | undefined;'
return:
type: typeof @microsoft/sp-webpart-base!~microsoftTeams | undefined
- name: sdks
uid: '@microsoft/sp-webpart-base!WebPartContext#sdks:member'
package: '@microsoft/sp-webpart-base!'
fullName: sdks
summary: Conditional set of SDKs provided by SPFx dependent on the environment.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get sdks(): ISDKs;'
return:
type: '<xref uid="@microsoft/sp-webpart-base!ISDKs:interface" />'
- name: statusRenderer
uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member'
package: '@microsoft/sp-webpart-base!'
fullName: statusRenderer
summary: Web part status renderer.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;'
return:
type: '<xref uid="@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer:interface" />'
- name: widthCacheKey
uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member'
package: '@microsoft/sp-webpart-base!'
fullName: widthCacheKey
summary: >-
This functions returns a key generated by web parts display mode, layout index, and section factor. It will return
undefined if sectionFactor or display mode is undefined, else return the cache key.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'get widthCacheKey(): string | undefined;'
return:
type: string | undefined
extends: '<xref uid="@microsoft/sp-webpart-base!BaseWebPartContext:class" />'