useLabelConfig

function useLabelConfig(labelMap: SharedImageSet | null): {
  labelConfigs: Map<number, LabelConfig> | undefined;
  setLabelConfigs: (labelConfigMap: Map<number, LabelConfig>) => void;
  setLabelConfig: (labelValue: number, labelConfig: LabelConfig) => void;
};

Returns the reactive LabelConfigMap state of a label map.

Subscribes to onLabelConfigChanged

Parameters

Parameter	Type	Description
`labelMap`	SharedImageSet \| `null`	The label map to observe

Returns

{
  labelConfigs:   | Map<number, LabelConfig>
     | undefined;
  setLabelConfigs: (labelConfigMap: Map<number, LabelConfig>) => void;
  setLabelConfig: (labelValue: number, labelConfig: LabelConfig) => void;
}

The current label config state as a Map<number, LabelConfig>, a function to change the whole map and a function to change individual entries

Name	Type
`labelConfigs`	\| Map<`number`, LabelConfig> \| `undefined`
`setLabelConfigs()`	(`labelConfigMap`: Map<`number`, LabelConfig>) => `void`
`setLabelConfig()`	(`labelValue`: `number`, `labelConfig`: LabelConfig) => `void`

Throws

If called outside of an ImFusionProvider

Throws

If called before the SDK has finished initializing

Example

tsx

function ToggleLabelVisibility({ labelMap }: { labelMap: SharedImageSet }) {
  const { labelConfigs, setLabelConfigs, setLabelConfig } = useLabelConfig(labelMap);

  if (!labelConfigs) return;

  const keys = [...labelConfigs.keys()];
  const toggleVisibility = (labelValue: number, config: LabelConfig) => {
    let next = config;
    next.isVisible2d = !next.isVisible2d;
    setLabelConfig(labelValue, next);
  };

  return (
    <ul>
      {keys.map((labelValue) => {
        const config = labelConfigs.get(labelValue)!;
        return (
          <li onClick={() => toggleVisibility(labelValue, config)}>
            {config.isVisible2d ? 'visible' : 'invisible'}
          </li>
        );
      })}
    </ul>
  );
}
}