-
Notifications
You must be signed in to change notification settings - Fork 60
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
styleSettings API introduction #38
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
packages/components/src/components/iot-connector/bindStylesToDataStreams.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| import { bindStylesToDataStreams } from './bindStylesToDataStreams'; | ||
| import { DATA_STREAM, DATA_STREAM_2 } from '../../testing/mockWidgetProperties'; | ||
|
|
||
| it('returns empty array when provided no data streams', () => { | ||
| expect( | ||
| bindStylesToDataStreams({ | ||
| dataStreams: [], | ||
| styleSettings: { someStyle: { color: 'red' } }, | ||
| }) | ||
| ).toEqual([]); | ||
| }); | ||
|
|
||
| it('returns data streams when no matching styles', () => { | ||
| expect( | ||
| bindStylesToDataStreams({ | ||
| dataStreams: [DATA_STREAM], | ||
| styleSettings: { someStyle: { color: 'red' } }, | ||
| }) | ||
| ).toEqual([DATA_STREAM]); | ||
| }); | ||
|
|
||
| it('associates styles to corresponding data stream', () => { | ||
| expect( | ||
| bindStylesToDataStreams({ | ||
| dataStreams: [{ ...DATA_STREAM, refId: 'someStyle' }], | ||
| styleSettings: { someStyle: { color: 'red' } }, | ||
| }) | ||
| ).toEqual([{ ...DATA_STREAM, refId: 'someStyle', color: 'red' }]); | ||
| }); | ||
|
|
||
| it('associates styles to corresponding data stream for multiple data streams', () => { | ||
| expect( | ||
| bindStylesToDataStreams({ | ||
| dataStreams: [ | ||
| { ...DATA_STREAM, refId: 'someStyle' }, | ||
| { ...DATA_STREAM_2, refId: 'someStyle2' }, | ||
| ], | ||
| styleSettings: { someStyle: { color: 'red' }, someStyle2: { color: 'blue' } }, | ||
| }) | ||
| ).toEqual([ | ||
| { ...DATA_STREAM, refId: 'someStyle', color: 'red' }, | ||
| { ...DATA_STREAM_2, refId: 'someStyle2', color: 'blue' }, | ||
| ]); | ||
| }); | ||
|
|
||
| it('returns data stream when no matching refId', () => { | ||
| expect( | ||
| bindStylesToDataStreams({ | ||
| dataStreams: [{ ...DATA_STREAM, refId: 'someStyle100' }], | ||
| styleSettings: { someStyle: { color: 'red' } }, | ||
| }) | ||
| ).toEqual([{ ...DATA_STREAM, refId: 'someStyle100' }]); | ||
| }); |
18 changes: 18 additions & 0 deletions
18
packages/components/src/components/iot-connector/bindStylesToDataStreams.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import { StyleSettingsMap, DataStream } from '@iot-app-kit/core'; | ||
|
|
||
| // If the data stream has a reference id with associated styles, append those styles to the data stream. | ||
| export const bindStylesToDataStreams = ({ | ||
| dataStreams, | ||
| styleSettings, | ||
| }: { | ||
| dataStreams: DataStream[]; | ||
| styleSettings?: StyleSettingsMap; | ||
| }): DataStream[] => | ||
| dataStreams.map((dataStream) => | ||
| styleSettings == null || dataStream.refId == null | ||
| ? dataStream | ||
| : { | ||
| ...dataStream, | ||
| ...styleSettings[dataStream.refId], | ||
| } | ||
| ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
(random thoughts) It initially felt strange to me to bind
styletodataStreams, since styles are metadata and not streamed. I see that it follows the synchro-chart API though, and these are essentiallyDataStreamStyles. Would we ever want to swap out synchro-charts as a viz library? If not then this approach seems fine.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.
how we bind
styleSettingswill be component specific, right nowiot-connectoris a bit specific to Synchro Charts, but we can refactor it as necessary as the need arises asiot-connectoris purely an internal helper and not intended to be used as part of the offerings of the library