Skip to content

Commit 6828fa1

Browse files
pgonzalpgonzal
committed
Generate files
1 parent 94cb78e commit 6828fa1

53 files changed

Lines changed: 762 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api/node-core-library.jsonschema.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Represents a JSON schema that can be used to validate JSON data files loaded by
1010

1111
Constructs a new instance of the `JsonSchema` class
1212

13+
## Properties
14+
15+
| Property | Access Modifier | Type | Description |
16+
| --- | --- | --- | --- |
17+
| [`shortName`](./node-core-library.jsonschema.shortname.md) | | `string` | Returns a short name for this schema, for use in error messages. |
18+
19+
1320
## Methods
1421

1522
| Method | Access Modifier | Returns | Description |

‎api/node-core-library.jsonschema.shortname.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- docId=node-core-library.jsonschema.shortname -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md) &gt; [JsonSchema](./node-core-library.jsonschema.md)
4+
5+
# JsonSchema.shortName property
6+
7+
Returns a short name for this schema, for use in error messages.
8+
9+
**Signature:**
10+
```javascript
11+
shortName: string
12+
```
13+
14+
## Remarks
15+
16+
If the schema was loaded from a file, then the base filename is used. Otherwise, the "id" field is used if available.

‎api/sp-webpart-base.baseclientsidewebpart.accessibletitle.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.accessibletitle -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.accessibleTitle property
6+
7+
This property points to the accessible title of web part made available to screen readers. The base implementation returns that default title in the manifest. Web parts that want to provide more descriptive title containing contextual information need to override this API.
8+
9+
**Signature:**
10+
```javascript
11+
accessibleTitle: string
12+
```

‎api/sp-webpart-base.baseclientsidewebpart.canopenpopuponrender.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.canopenpopuponrender -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.canOpenPopupOnRender property
6+
7+
This property indicates whether a web part can open a popup on initial render. In some environments the host re-renders the web parts frequently, and therefor, opening popups during render will cause popups to open repeatedly and hence poor user experience. As an example, the classic SharePoint pages perform postbacks and hence page re-render on all button clicks. If a web part needs to open a popup on render, it should use this API before opening the popup. If this API returns false, the web part should not open popup on initial render. Some web parts that open popups during render are the document embed web part that pops up the file picker on initial render, embedded video web part that pops up the PropertyPane on initial render.
8+
9+
**Signature:**
10+
```javascript
11+
canOpenPopupOnRender: boolean
12+
```

‎api/sp-webpart-base.baseclientsidewebpart.clearerror.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.clearerror -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.clearError method
6+
7+
This API should be used to clear the error message from the web part display area.
8+
9+
**Signature:**
10+
```javascript
11+
protected clearError(): void;
12+
```
13+
**Returns:** `void`
14+

‎api/sp-webpart-base.baseclientsidewebpart.context.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.context -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.context property
6+
7+
This property is a pointer to the web part context.see IWebPartContext for more details.
8+
9+
**Signature:**
10+
```javascript
11+
context: IWebPartContext
12+
```

‎api/sp-webpart-base.baseclientsidewebpart.dataversion.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.dataversion -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.dataVersion property
6+
7+
The value of this property is stored in the serialized data of the web part to allow developers to manage versioning of their web part. The default version is 1.0
8+
9+
**Signature:**
10+
```javascript
11+
dataVersion: Version
12+
```

‎api/sp-webpart-base.baseclientsidewebpart.description.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.description -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.description property
6+
7+
Description of the WebPart
8+
9+
**Signature:**
10+
```javascript
11+
description: string
12+
```

‎api/sp-webpart-base.baseclientsidewebpart.disablereactivepropertychanges.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.disablereactivepropertychanges -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.disableReactivePropertyChanges property
6+
7+
This property is used to change the web part's PropertyPane interaction from Reactive to NonReactive. The default behaviour is Reactive. Where, Reactive implies that changes made in the PropertyPane are transmitted to the web part instantly and the user can see instant updates. This helps the page creator get instant feedback and decide if they should keep the new configuration changes or not. NonReactive implies that the configuraiton changes are transmitted to the web part only after 'Apply' PropertyPane button is clicked.
8+
9+
**Signature:**
10+
```javascript
11+
disableReactivePropertyChanges: boolean
12+
```

‎api/sp-webpart-base.baseclientsidewebpart.displaymode.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=sp-webpart-base.baseclientsidewebpart.displaymode -->
2+
3+
[Home](./index.md) &gt; [sp-webpart-base](./sp-webpart-base.md) &gt; [BaseClientSideWebPart](./sp-webpart-base.baseclientsidewebpart.md)
4+
5+
# BaseClientSideWebPart.displayMode property
6+
7+
This property is the current display mode of the web part.
8+
9+
**Signature:**
10+
```javascript
11+
displayMode: DisplayMode
12+
```

0 commit comments

Comments
 (0)