-
Notifications
You must be signed in to change notification settings - Fork 261
[Excel](data types) New APIs for linked entities #5091
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Learn Build status updates of commit f2dec41: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
docs/excel/add-properties-to-basic-cell-values.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few teeny suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have some broad questions -- might be hard to discuss on the PR, maybe we can meet to discuss?
|
||
## Create a cell value with properties | ||
|
||
To create a cell value and add properties to it, use **valuesAsJson** to assign properties. The following objects offer the **valuesAsJson** property. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the thinking behind styling valuesAsJson as bold vs. wrapped in code ticks? The existing valuesAsJson content uses code ticks, and I think style guide rules are still to wrap all code elements in code ticks (but I could be wrong).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks yeah that's a mistake in the conversion from the word doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed.
|
||
The **layouts** property contains two direct subproperties, **compact** and **card**. The **card** property specifies the appearance of a card when the data type card is open. The compact property is optional, and defines the icon for a value. The icon is shown in the cell value if it is provided. It can also be shown in the card if it is referenced as a sub property. See the [EntityCompactLayoutIcons](/javascript/api/excel/excel.entitycompactlayouticons) enum for a full list of available icons. | ||
|
||
Within the **card** property, use the **BasicCardLayout** object to define the components of the card like **title**, **subTitle**, and **sections**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see BasicCardLayout in any of the code samples. Should it be? I was expecting to find it in the following sample. Maybe we could add a sentence explaining what it is?
|
||
:::image type="content" source="../images/data-type-basic-provider-information.png" alt-text="Data type card showing the search logo for Contoso generic search."::: | ||
|
||
## Compatibility |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we put this section on the Overview article? It seems relevant to all the data types
|
||
The number formatting is considered the default format. If the user, or other code, applies formatting to a cell containing a formatted number, the applied format will override the number’s format. | ||
|
||
## Card layout |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broad question:
It looks like the next three sections are very similar to sections in the existing Entity value cards article. Is the main difference that these new sections describe how to add properties to CellValueTypes other than entity
? If so, is separating the articles into entity/not-entity like this, the most logical? Should we have an article for each type? Such as one article each for entity, double, string, etc.
|
||
:::image type="content" source="../images/data-type-basic-nested-entities.png" alt-text="Cell value in Excel showing battery charge at 70% and the data type card showing the nested laptop entity with charging and power consuption property values."::: | ||
|
||
## Attribution |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this Attribution content -- maybe we create a new article called Data types attribution and describe how to do attributions for all the types? I think the similarity with this Card data attribution section could be confusing
Co-authored-by: Linda Cannon <[email protected]> Co-authored-by: Alex Jerabek <[email protected]> Co-authored-by: Alison McKay <[email protected]>
Learn Build status updates of commit f7eccba: 💡 Validation status: suggestions
docs/excel/add-properties-to-basic-cell-values.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit 2c68d7f: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit b637b24: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit b403895: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
docs/excel/excel-data-types-linked-entity-cell-values.md
docs/toc.yml
docs/excel/excel-data-types-concepts.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit 7bd616a: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
docs/excel/excel-data-types-linked-entity-cell-values.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit 3c7230c: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
docs/excel/excel-data-types-linked-entity-cell-values.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
ms.localizationpriority: medium | ||
--- | ||
|
||
# Add properties to basic cell values |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this article be tagged as preview? Should any of the other content in this PR (some of the entity card content?) be tagged as preview?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it's not available to all, then yes it should be tagged preview.
Content for new APIs on linked entities.