Skip to content

[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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

davidchesnut
Copy link
Member

@davidchesnut davidchesnut commented Mar 18, 2025

Content for new APIs on linked entities.

  • Adding properties and cards to basic cell value types.
  • Adding linked entities.
  • Rework articles on concepts and card layouts to incorporate the new types.

Copy link
Contributor

Learn Build status updates of commit f2dec41:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
docs/excel/add-properties-to-basic-cell-values.md ❌Error Details

docs/excel/add-properties-to-basic-cell-values.md

  • Line 21, Column 1: [Error: invalid-image] Invalid attribute.

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:

Copy link
Member

@lindalu-MSFT lindalu-MSFT left a 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.

Copy link
Contributor

@alison-mk alison-mk left a 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.
Copy link
Contributor

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).

Copy link
Member Author

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.

Copy link
Member Author

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**.
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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]>
Copy link
Contributor

Learn Build status updates of commit f7eccba:

💡 Validation status: suggestions

File Status Preview URL Details
docs/excel/add-properties-to-basic-cell-values.md 💡Suggestion View Details
docs/images/data-type-basic-card-attribution.png ✅Succeeded View
docs/images/data-type-basic-card-layout.png ✅Succeeded View
docs/images/data-type-basic-data-type-card.png ✅Succeeded View
docs/images/data-type-basic-dot-syntax.png ✅Succeeded View
docs/images/data-type-basic-fields.png ✅Succeeded View
docs/images/data-type-basic-nested-entities.png ✅Succeeded View
docs/images/data-type-basic-provider-information.png ✅Succeeded View
docs/toc.yml ✅Succeeded View

docs/excel/add-properties-to-basic-cell-values.md

  • Line 305, Column 121: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/javascript/api/excel/excel.cellvalueattributionattributes' will be broken in isolated environments. Replace with a relative link.

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:

Copy link
Contributor

Learn Build status updates of commit 2c68d7f:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit 2c68d7fd407502e3ad189ca9cd4382936872767d in branch davech-c of repository https://github.com/OfficeDev/office-js-docs-pr into branch main (commit 74a8e1dd228d78e671e390b2bc2906a9a79c2162). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

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:

Copy link
Contributor

Learn Build status updates of commit b637b24:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit b637b241c806fd21355c03dd6cdf7b08e7492b1e in branch davech-c of repository https://github.com/OfficeDev/office-js-docs-pr into branch main (commit 74a8e1dd228d78e671e390b2bc2906a9a79c2162). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

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:

Copy link
Contributor

Learn Build status updates of commit b403895:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
docs/excel/excel-data-types-linked-entity-cell-values.md ❌Error Details
docs/toc.yml ⚠️Warning Details
docs/excel/excel-data-types-concepts.md 💡Suggestion Details

docs/excel/excel-data-types-linked-entity-cell-values.md

  • Line 32, Column 1: [Error: invalid-image] Invalid attribute.

docs/toc.yml

  • Line 497, Column 17: [Warning: file-not-found - See documentation] Invalid file link: 'excel/add-properties-to-basic-cell-values.md'.

docs/excel/excel-data-types-concepts.md

  • Line 40, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /javascript/api/excel/excel.externalcodeserviceobjectcellvalue?view=excel-js-preview

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:

@davidchesnut davidchesnut changed the title [Excel](data types) Add properties to basic cell values [Excel](data types) New APIs for linked entities Apr 14, 2025
Copy link
Contributor

Learn Build status updates of commit 7bd616a:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
docs/excel/excel-data-types-linked-entity-cell-values.md ❌Error Details

docs/excel/excel-data-types-linked-entity-cell-values.md

  • Line 32, Column 1: [Error: invalid-image] Attribute "type" specified multiple times.

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:

Copy link
Contributor

Learn Build status updates of commit 3c7230c:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
docs/excel/excel-data-types-linked-entity-cell-values.md ❌Error Details

docs/excel/excel-data-types-linked-entity-cell-values.md

  • Line 32, Column 1: [Error: invalid-image] Attribute "type" specified multiple times.

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
Copy link
Contributor

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?

Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants